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

List bank details

GET /v1/bank-details

Returns a list of bank details with support for filtering, sorting, and auto-pagination. A bank detail always belongs to a specific requisite — to get the bank details of a specific requisite, filter by entityId.

Parameters

Parameter Type Default Description
Parameterlimit Typenumber Default50 DescriptionNumber of records (up to 5000). When limit > 50, Vibecode automatically requests several pages from Bitrix24
Parameteroffset Typenumber Default0 DescriptionSkip N records. At offset ≥ 2500, limit ≤ 500 is recommended
Parameterselect Typestring Default— DescriptionField selection: ?select=id,name,rqBik,rqAccNum
Parametersort Typestring Default— DescriptionSorting via the short syntax: ?sort=-id, the minus means descending. Several fields are comma-separated: ?sort=-id,name
Parameterorder Typeobject Default— DescriptionSorting: ?order[id]=desc. When both sort and order are passed, sort applies
Parameterfilter Typeobject Default— DescriptionFilter by the fields from GET /v1/bank-details/fields.
Filtering syntax. Example: ?filter[entityId]=3

Examples

curl — personal key

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/bank-details?filter[entityId]=3" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/bank-details?filter[entityId]=3" \
  -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/bank-details?filter[entityId]=3', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/bank-details?filter[entityId]=3', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of bank details (all fields — see Bank detail fields)
Fieldmeta.total Typenumber DescriptionTotal number of records matching the filter
Fieldmeta.hasMore Typeboolean DescriptionWhether there are more records beyond limit

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 3,
      "entityId": 3,
      "countryId": 1,
      "name": "Bank details 1",
      "active": true,
      "sort": 500,
      "code": null,
      "xmlId": null,
      "rqBankName": "Details 1",
      "rqBankAddr": null,
      "rqBik": null,
      "rqAccNum": null,
      "rqCorAccNum": null,
      "rqSwift": null,
      "rqIban": null,
      "createdAt": "2020-05-22T11:56:53.000Z",
      "updatedAt": "2023-12-05T11:50:19.000Z",
      "createdBy": 1,
      "modifyBy": 779
    },
    {
      "id": 5,
      "entityId": 11,
      "countryId": 1,
      "name": "Bank details 1",
      "active": true,
      "sort": 500,
      "code": null,
      "xmlId": null,
      "rqBankName": "bank",
      "rqBankAddr": "test address",
      "rqBik": "13142323452",
      "rqAccNum": "234245746878032451534",
      "rqCorAccNum": "235134524566748725431",
      "rqSwift": null,
      "rqIban": null,
      "createdAt": "2020-06-30T09:53:58.000Z",
      "updatedAt": null,
      "createdBy": 1,
      "modifyBy": null
    }
  ],
  "meta": {
    "total": 6,
    "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
HTTP403 CodeSCOPE_DENIED DescriptionAPI key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionAPI key has no configured tokens
HTTP400 CodeINVALID_FILTER DescriptionError in filter syntax
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

entityTypeId is not returned in the response. This field is passed only on creation. It is absent from the GET /v1/bank-details and GET /v1/bank-details/:id responses.

countryId = 0 when no country is set. If no country is specified, the countryId field is returned as 0, not null.

Auto-pagination. When limit > 50, Vibecode automatically requests several pages from Bitrix24 and returns all records in a single response.

See also