activities
activity-types
companies
countries
currencies
custom-fields
deals
exports
files
imports
lost-reasons
notes
phone-codes
pipelines
products
search
search-filters
stages
timezones
users
webhook-events
webhook-requests
webhooks
Models
Powered by Stoplight
get

/contacts.json

Returns a list of contacts, they are returned sorted by name by default.

The following values are allowed in the include query parameter:

  • avatar
  • company.country
  • country
  • owner.avatar

The following targets are allowed in filter query parameters:

  • companyExists
  • companyId
  • createdAt
  • dealId
  • email
  • id
  • name
  • updatedAt

The following values are allowed in the sort query parameter:

  • address
  • country
  • createdAt
  • firstName
  • lastName
  • mainEmail
  • mainPhone
  • name (default)
  • updatedAt

Request Parameters

5 Query Parameters

Responses

200 OK

Schema
object
contacts
array[object]
included
object

Included contains all the side-loaded data of a response. See including related entities.

meta
object

ResponseMeta contains common meta data.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host