List contacts
Paginated contacts. `search` matches name fields, unique numbers, tax/vat ids, notes, and nested emails/phones/addresses.
get
/api/v1/contacts
Security
Parameters
| Name | In | Type | Details | |
|---|---|---|---|---|
page |
query |
integer
|
optional |
Default:
1 |
per_page |
query |
integer
|
optional |
Items per page (1–100, default 15) Default:
15 |
search |
query |
string
|
optional | Search across entity fields and nested CRM emails/phones/addresses |
Responses
200
Paginated contacts
application/json
{
"allOf": [
{
"title": "API envelope",
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
},
"errors": {
"nullable": true
},
"meta": {
"type": "object",
"nullable": true,
"additionalProperties": true
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"title": "Contact",
"type": "object",
"description": "Contact in list/show/create/update responses.",
"required": [
"id",
"display_name"
],
"properties": {
"id": {
"type": "integer"
},
"uuid": {
"type": "string",
"nullable": true
},
"firstname": {
"type": "string",
"nullable": true
},
"lastname": {
"type": "string",
"nullable": true
},
"display_name": {
"type": "string"
},
"unique_number": {
"type": "string",
"nullable": true
},
"unique_number_display": {
"type": "string",
"nullable": true
},
"source": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"website": {
"type": "string",
"nullable": true
},
"birthday": {
"type": "string",
"format": "date",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"salutation": {
"oneOf": [
{
"title": "Salutation",
"type": "object",
"required": [
"id",
"salutation"
],
"properties": {
"id": {
"type": "integer"
},
"salutation": {
"type": "string"
}
}
},
{
"type": "null"
}
]
},
"addresses": {
"type": "array",
"items": {
"title": "Address",
"type": "object",
"description": "Address in responses.\n",
"required": [
"address_line_1",
"is_primary"
],
"properties": {
"id": {
"type": "integer",
"nullable": true
},
"contacts_id": {
"type": "integer",
"nullable": true
},
"partners_id": {
"type": "integer",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"address_line_1": {
"type": "string"
},
"address_line_2": {
"type": "string",
"nullable": true
},
"zip_code": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"district": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"is_primary": {
"type": "boolean"
},
"country": {
"oneOf": [
{
"title": "Country",
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"iso2": {
"type": "string",
"nullable": true
},
"iso3": {
"type": "string",
"nullable": true
},
"numeric_code": {
"type": "string",
"nullable": true
},
"phone_code": {
"type": "string",
"nullable": true
},
"capital": {
"type": "string",
"nullable": true
},
"currency": {
"type": "string",
"nullable": true
},
"currency_symbol": {
"type": "string",
"nullable": true
},
"native": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"subregion": {
"type": "string",
"nullable": true
}
}
},
{
"type": "null"
}
]
}
}
}
},
"phones": {
"type": "array",
"items": {
"title": "Phone",
"type": "object",
"description": "Phone in responses.",
"required": [
"number",
"is_primary"
],
"properties": {
"id": {
"type": "integer",
"nullable": true
},
"contacts_id": {
"type": "integer",
"nullable": true
},
"partners_id": {
"type": "integer",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"country_code": {
"type": "string",
"nullable": true
},
"number": {
"type": "string"
},
"extension": {
"type": "string",
"nullable": true
},
"e164_number": {
"type": "string",
"nullable": true
},
"is_primary": {
"type": "boolean"
}
}
}
},
"emails": {
"type": "array",
"items": {
"title": "Email",
"type": "object",
"description": "Email in responses.",
"required": [
"email",
"is_primary"
],
"properties": {
"id": {
"type": "integer",
"nullable": true
},
"contacts_id": {
"type": "integer",
"nullable": true
},
"partners_id": {
"type": "integer",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"format": "email"
},
"is_primary": {
"type": "boolean"
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"title": "Pagination",
"type": "object",
"properties": {
"current_page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"total": {
"type": "integer"
},
"last_page": {
"type": "integer"
},
"from": {
"type": "integer",
"nullable": true
},
"to": {
"type": "integer",
"nullable": true
}
}
}
}
}
}
}
]
}
401
Missing or invalid API key
application/json
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Missing API key (X-Api-Key)"
}
}
}