contacts:read| Parameter | Type | Description |
|---|---|---|
id | integer | Required. The contact ID |
| Parameter | Type | Description |
|---|---|---|
include | string | Comma-separated list of relationships to include |
groups, source, statusContactResource format.| Field | Type | Description |
|---|---|---|
id | integer | Contact ID |
firstname | string | First name |
lastname | string | Last name |
company | string|null | Company name |
type | string | Contact type: lead, customer, guest |
email | string|null | Email address |
phone | string|null | Phone number |
status_id | integer | Status ID |
source_id | integer | Source ID |
description | string|null | Description |
city | string|null | City |
state | string|null | State |
zip | string|null | ZIP/postal code |
address | string|null | Street address |
country_id | integer|null | Country ID |
assigned_id | integer|null | Assigned user ID |
group_id | array | Array of group IDs |
is_opted_out | boolean | Opt-out status (default: false) |
created_at | string | ISO 8601 datetime |
updated_at | string | ISO 8601 datetime |
groups | array | Groups data (when include=groups). Each: { id, name, created_at, updated_at } |
source | object | Source data (when include=source). Fields: { id, name, created_at, updated_at } |
status | object | Status data (when include=status). Fields: { id, name, color, created_at, updated_at } |
| Status | Code | Description |
|---|---|---|
| 404 | NOT_FOUND | Contact not found |
| 500 | INTERNAL_ERROR | Failed to fetch contact |
curl --location --request GET '/contacts/1?include=groups,source,status' \
--header 'Authorization: Bearer <token>'{}