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

List companies

GET /v1/companies

Returns a list of companies with filtering, sorting and auto-pagination.

Parameters

Parameter Type Default Description
Parameterlimit Typenumber Default50 DescriptionNumber of records (up to 5000)
Parameteroffset Typenumber Default0 DescriptionSkip N records. To walk the entire collection, a cursor is cheaper — order[id]=asc plus filter[>id] from meta.nextAfterId
Parameterselect Typestring Default— DescriptionField selection: ?select=id,title,phone,industry
Parametersort Typestring Default— DescriptionSorting via the short syntax: ?sort=-title, the minus means descending
Parameterorder Typeobject Default— DescriptionSorting: ?order[title]=asc
Parameterfilter Typeobject Default— DescriptionFilter by fields from GET /v1/companies/fields.
Filtering syntax. Example: ?filter[industry]=IT
ParameterwithTotal Typestring Default— DescriptionWhether you need the count: true or false. false — do not request a count. This is the only way to guarantee that meta.total is absent from the response. Without the parameter: the API key setting applies, then the platform default — and in that case a short page still carries the exact count even without an explicit request. Paging and counts

Examples

curl — personal key

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/companies?limit=3&filter[industry]=IT&select=id,title,phone" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/companies?limit=3&filter[industry]=IT&select=id,title,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/companies?limit=3&filter[industry]=IT&select=id,title,phone', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Received ${data.length} companies`)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/companies?limit=3&filter[industry]=IT&select=id,title,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
Fielddata Typearray DescriptionArray of companies (fields — see Fields)
Fieldmeta.total Typenumber DescriptionTotal number of records. An optional field: if no count was requested, it is absent from the response
Fieldmeta.hasMore Typeboolean DescriptionMore records available
Fieldmeta.nextAfterId Typestring DescriptionThe identifier of the last returned record. Returned when the sort is strictly id ascending, while hasMore is true. Pass it back as filter[>id] — a cheap replacement for a growing offset

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

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

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

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "title": "Acme Inc",
      "phone": "+15555555555"
    },
    {
      "id": 3,
      "title": "Globex LLC",
      "phone": "+15555555556"
    },
    {
      "id": 7,
      "title": "Initech LLC",
      "phone": "+15555555557"
    }
  ],
  "meta": {
    "hasMore": true,
    "nextAfterId": "7"
  }
}

Error response example

403 — no scope:

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

Errors

HTTP Code Description
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
HTTP429 CodeRATE_LIMITED DescriptionRate limit exceeded: 300 requests per minute per portal. All API keys of the portal share one limit. The current limit is returned in the x-ratelimit-limit header. Retry after the delay in the Retry-After header

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 company 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 company by phone number in any format and by any of its numbers, use Duplicate search.

When to use search. For compound conditions use POST /v1/companies/search. See Search companies.

See also