API ReferenceContacts

Get contact

View as Markdown

Returns a single workspace contact. Requires the contacts:read scope.

Authentication

AuthorizationBearer

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

Path parameters

contact_idstringRequired

Response headers

X-RateLimit-Limitinteger

Maximum number of authenticated requests allowed for the workspace in the current 60-second window. The limit is 1000 and applies to all /api/v2 resource routes (GET, POST, PATCH, and DELETE), shared across every credential for the workspace.

X-RateLimit-Remaininginteger
Number of requests remaining in the current window before the limit is exceeded.
X-RateLimit-Resetinteger

Unix epoch seconds when the current rate-limit window resets.

ETagstringOptional
X-Api-VersionstringOptional

Response

Contact response.
objectenum
Resource discriminator for contact payloads.
idstringformat: "^cnt_[A-Za-z0-9]+$"
Stable AskElephant contact identifier.
created_atdatetime
Timestamp when the contact was first created in AskElephant.
updated_atdatetime
Timestamp when the contact was most recently updated in AskElephant.
first_namestring or nullOptional
Contact given name.
last_namestring or nullOptional
Contact family name.
descriptionstringOptional

Free-form contact summary or notes visible through the public API.

companyobjectOptional
Lightweight reference to the contact's associated company when one exists.
emailslist of objectsOptional
Email addresses associated with the contact.
phone_numberslist of objectsOptional
Phone numbers associated with the contact.
crm_associationobjectOptional
CRM record linked to this contact. Present when the contact has been matched to a CRM record via integration or API.
time_zonestringOptional
IANA time zone identifier for the contact.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error