Retrieve a contact
Authorizations
A workspace API token. Create one in Settings → API. Send it as Authorization: Bearer sk_live_....
Path Parameters
Unique identifier for a contact.
^con_[0-9a-f]{32}$"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Query Parameters
Comma-separated relationships to inline in the response. Unexpanded relations are still identified by their *_id field.
"organization,owner"
Comma-separated fields to return. object and id are always included. Reduces payload size, not query cost.
"name,email,organization_id"
Response
Successful Response
A person in your CRM.
Unique identifier for a contact.
^con_[0-9a-f]{32}$"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Where the contact stands.
open, on_hold, won, lost Governs who sees this record in the Sailer UI. API tokens are workspace-scoped and are not filtered by it.
private, team, team_and_subteams, company Short-lived signed URL; do not store it.
Free-text employer name. Unrelated to your workspace and to organization, which is a CRM record.
Every custom field defined on contacts in this workspace, keyed by field key and typed from its definition. Unset fields are null, so reading any contact shows the full set of keys in use.
Name of the reason, when status is lost.
Display name. Derived from first_name and last_name.
"contact"Populated only when organization is in expand.
Unique identifier for an organization.
^org_[0-9a-f]{32}$"org_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
Populated only when owner is in expand.
Unique identifier for an user.
^usr_[0-9a-f]{32}$"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"
E.164. Normalized on write.
cold, warm, hot