#List contacts

GET /v1/contacts

Returns a list of contacts with support for filtering, sorting, and auto-pagination.

#Parameters

Parameter Type Default Description
limit number 50 Number of records (up to 5000). At limit > 50 — auto-pagination
offset number 0 Skip N records. At offset > 0, limit ≤ 500 is recommended
select string — Field selection: ?select=id,name,lastName,phone
order object — Sorting: ?order[lastName]=asc
filter object — Filtering by GET /v1/contacts/fields fields.
Filtering syntax. Example: ?filter[companyId]=15

#Examples

#curl — personal key

Terminal 
curl "https://vibecode.bitrix24.tech/v1/contacts?limit=10&filter[companyId]=15&select=id,name,lastName,phone" \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth app

Terminal 
curl "https://vibecode.bitrix24.tech/v1/contacts?limit=10&filter[companyId]=15&select=id,name,lastName,phone" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/contacts?limit=10&filter[companyId]=15&select=id,name,lastName,phone', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Found ${meta.total} contacts`)

#JavaScript — OAuth app

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/contacts?limit=10&filter[companyId]=15&select=id,name,lastName,phone', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()

#Response fields

Field Type Description
data array Array of contacts (fields — see Fields)
meta.total number Total number of records
meta.hasMore boolean More records available

The card URL of any contact from the data array is its id:

https://<portal>.bitrix24.ru/crm/contact/details/<id>/

<portal> — the portal domain. Access is restricted by the employee's permissions in Bitrix24.

#Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 17,
      "name": "Ivan",
      "lastName": "Petrov",
      "phone": "74955553546",
      "email": "ivan@company.ru",
      "companyId": 1,
      "assignedById": 1,
      "sourceId": "EMAIL",
      "typeId": "CLIENT"
    }
  ],
  "meta": {
    "total": 1167,
    "hasMore": true
  }
}

#Error response example

403 — no scope:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

#Errors

HTTP Code Description
403 SCOPE_DENIED API key lacks the crm scope
401 TOKEN_MISSING API key has no configured tokens

Full list of common API errors — Errors.

#Known specifics

Auto-pagination: at limit > 50 VibeCode automatically requests multiple pages.

When to use search: for complex filters POST /v1/contacts/search is more convenient — parameters go in the body. See Search contacts.

#See also