List contacts

GET /v1/contacts

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

Parameters

You can also filter by the contact category using categoryId, for example filter[categoryId]=0 in a GET request or { "filter": { "categoryId": 0 } } in the search request body. Use the exact spelling categoryId.

Examples

curl — personal key

curl -g "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 application

curl -g "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

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 application

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

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 portal domain. Access is restricted by the employee's permissions in Bitrix24.

Response example

{
  "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:

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

Errors

For the full list of common API errors, see 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.

Email addresses by type. Besides email with the primary value, a contact returns three expanded fields — emailWork, emailHome, and emailMailing. You can list them in select and filter by them: ?select=id,name,emailWork and ?filter[emailWork]=info@example.com. An address is written through email only, so these three fields are read-only. When the contact has no address of that type, null comes back.

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

• Search contacts
• Create contact
• Duplicate search
• Filtering syntax
• Batch
• Limits and optimization