For AI agents: markdown of this page — /docs-content-en/entities/contacts/list.md documentation index — /llms.txt

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). Auto-pagination is applied when limit > 50
offset number 0 Skip N records. When offset > 0, limit ≤ 500 is recommended
select string — Field selection: ?select=id,name,lastName,phone
order object — Sorting: ?order[lastName]=asc
filter object — Filter by fields from GET /v1/contacts/fields.
Filtering syntax. Example: ?filter[companyId]=15

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/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.com/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.com/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.com/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 built from its id:

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

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

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 17,
      "name": "John",
      "lastName": "Brown",
      "phone": "12025550123",
      "email": "john@example.com",
      "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

The phone filter is not suitable for every search. A value without an operator is compared against the whole stored string: a contact whose number is stored as +1 (202) 555-0123 matches that exact string, but not 12025550123, because the plus sign, spaces, parentheses, and hyphens are part of the value. The filter also checks only the first number stored on a record: if both a work number and a mobile number are stored, searching by the mobile one returns an empty list. To find a contact by phone number in any format and by any of its numbers, use Duplicate search.

Auto-pagination: when limit > 50, Vibecode automatically requests multiple pages.

When to use search. For compound conditions, use POST /v1/contacts/search — parameters are passed in the request body. See Search contacts.

See also