Skip to navigation

Fetch a single contact

View as Markdown

Fetch a single contact by ID.

Returns 404 if the contact doesn’t exist or you can’t access its lead.

Use _fields to return only the fields you need. lead_id is always returned. Custom field values appear as custom.{custom_field_id} keys.

Authentication

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Response

Successful response
created_bystring or null

ID of the user who created the contact, e.g. user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA

date_createddatetime
When the contact was created, as an ISO 8601 timestamp in UTC
date_updateddatetime
When the contact was last updated, as an ISO 8601 timestamp in UTC
display_namestring

Name to display for the contact: the contact’s name if set, otherwise the first email address, then the first phone number in international format, then Unnamed

idstring

The contact’s ID, e.g. cont_q4xYmlGhA3060dEl0NDJuHRxPMuVjqLn30AFSzh1fRk

namestring or null
Full name of the contact, or null if unnamed
organization_idstring

The owning organization’s ID, e.g. orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH

titlestring or null

Job title of the contact, e.g. CEO, or null if unset

updated_bystring or null

ID of the user who last updated the contact, e.g. user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA

created_by_agent_idstring or nullOptional
ID of the agent that created the contact, or null if no agent created it
emailslist of objectsOptional
Email addresses of the contact
lead_idstring or nullOptional

The owning lead’s ID, e.g. lead_etYl6PwL12hkj14567kjolJwZuZehb9b85EDH9CKuAI. Every contact belongs to exactly one lead. Always returned, even when not requested in _fields.

phoneslist of objectsOptional
Phone numbers of the contact
timezonestring or nullOptional

IANA timezone ID of the contact, e.g. America/New_York. Set manually, or else inferred from the contact’s phone numbers. Null if neither is available. See timezone_source.

timezone_sourcestring or nullOptional

Where timezone came from: manual if set explicitly, inferred_from_phone_number if derived from the contact’s phone numbers, or null if timezone is null

updated_by_agent_idstring or nullOptional
ID of the agent that last updated the contact, or null if the last update wasn't made by an agent
urlslist of objectsOptional
URLs associated with the contact

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error