contacts

List Contacts

Returns a collection of Contacts

<Info title="Required scopes"> > `contacts:read` </Info>
get/contacts

Request

  • Base URL: https://api.calendly.com
  • URL: https://api.calendly.com/contacts
  • Auth: HTTP bearer

Query parameters

sortstring

Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: created_at, updated_at. Sort direction is specified as: asc, desc.

emailstring

Filter results by exact match on email address. Accepts a comma-separated list.

phone_numberstring

Filter results by exact match on phone number. Accepts a comma-separated list.

timezonestring

Filter results by exact match on the IANA time zone name(s). Accepts a comma-separated list of time zones.

namestring

Filter results by partial match on name(s). Accepts a comma-separated list-- each segment is matched independently (commas in the query string separate values).

job_titlestring

Filter results by partial match on job title(s). Accepts a comma-separated list-- each segment is matched independently (commas in the query string separate values).

companystring

Filter results by partial match on company name(s). Accepts a comma-separated list-- each segment is matched independently (commas in the query string separate values).

countrystring

Filter results by exact match on two-letter country code (ISO 3166-1 alpha-2). Accepts a comma-separated list.

statestring

Filter results by exact match on state(s), province(s), or region(s). Accepts a comma-separated list of values.

citystring

Filter results by partial match on city(ies). Accepts a comma-separated list-- each segment is matched independently (commas in the query string separate values).

countinteger

The number of rows to return

page_tokenstring

The token to pass to get the next or previous portion of the collection

excludestring

Omit the listed fields from the response. Currently only custom_fields is supported. When omitted, all fields are returned.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.