Hanzo
OpenapiCrm

Returns one of the caller org's contacts.

Returns one of the caller org's contacts.

GET /v1/crm/contacts/{id}

Addresshttps://api.hanzo.ai/v1/crm/contacts/{id}
MethodGET
Operationget_crm_contacts_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one of the caller org's contacts. An id belonging to another org reads as not found.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the record to act on, from the path.

Response

StatusBodyMeaning
200Contactok

200 body — 12 fields.

FieldInTypeAlwaysDescription
citybodystringCity is where the person is based.
companyIdbodystringCompanyID links the contact to one of the org's companies; empty when the contact stands alone, and cleared when its company is deleted.
createdAtbodyintegerCreatedAt is the unix second the contact was created.
emailbodystringEmail is the person's email address.
firstNamebodystringFirstName is the person's given name.
idbodystringID is the server-minted contact id ("cont_" + 128 random bits).
jobTitlebodystringJobTitle is the person's role at their company.
lastNamebodystringLastName is the person's family name.
linkedinLinkbodystringLinkedin is the person's LinkedIn URL.
phonebodystringPhone is the person's phone number.
updatedAtbodyintegerUpdatedAt is the unix second of the last write.
xLinkbodystringXLink is the person's X (Twitter) URL.

Failure carries the platform error shape — see Errors.

Examples

hanzo crm contacts get <id>

CRM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page