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

List payer types

GET /v1/person-types

Retrieves online store payer types with filtering, sorting, and pagination.

Parameters

Parameter Type Default Description
Parameterfilter (query) Typeobject Default— DescriptionFilter by fields from GET /v1/person-types/fields.
Filtering syntax. Example: ?filter[id]=21
Parameterselect (query) Typestring Default— DescriptionComma-separated fields, for example ?select=id,name,active. Only selected fields remain in data. Unknown names are reported in meta.warnings with the code UNKNOWN_SELECT_FIELD
Parametersort (query) Typestring Default— DescriptionSort by field: ?sort=id, or ?sort=-id for descending order
Parameterorder (query) Typeobject Default— DescriptionSort using an object: ?order[id]=desc
Parameterlimit (query) Typenumber Default50 DescriptionNumber of records, from 1 to 5000. Values above 5000 are capped at 5000
Parameteroffset (query) Typenumber Default0 DescriptionNumber of records to skip
ParameterwithTotal (query) Typestring Default— DescriptionAccepts true or false, but does not change counting or the presence of meta.total for payer types

Pagination. When limit > 50, Vibecode automatically reads multiple pages of 50 records and combines them into one response. To fetch the next set, increase offset by the number of records received. Continue while meta.hasMore is true.

Examples

curl — personal key

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/person-types?filter[id]=21" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

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

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

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/person-types?filter[id]=21', {
  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 payer types
Fielddata[].id Typenumber DescriptionPayer type ID, RO. List: GET /v1/person-types
Fielddata[].name Typestring DescriptionName
Fielddata[].code Typestring | null DescriptionUnique code
Fielddata[].sort Typenumber DescriptionSort order
Fielddata[].active Typeboolean DescriptionWhether the type is active
Fielddata[].xmlId Typestring | null DescriptionExternal ID
Fieldmeta.total Typenumber DescriptionTotal number of types matching the filter. Omitted on an empty page when offset > 0
Fieldmeta.hasMore Typeboolean DescriptionWhether more records exist beyond the current set
Fieldmeta.warnings Typearray DescriptionParameter warnings with code, message, and field. Only included when warnings exist
Fieldmeta.pageErrorSample Typeobject DescriptionThe code and message of an error that stopped automatic pagination early. In this case, data contains the records read before the error

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "active": true,
      "code": "DOCS_PERSON_397F55D8FB1D",
      "id": 21,
      "name": "Updated documentation payer",
      "sort": 910,
      "xmlId": "DOCS_PERSON_397F55D8FB1D"
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

Error response example

400 — sorting by an unknown field:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_SORT_FIELD",
    "message": "Unknown sort field 'unknownField' for entity 'person-types'. Available: id, name, code, sort, active, xmlId, lid"
  }
}

Errors

HTTP Code Description
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionThe filter uses a field absent from the schema. Field list: GET /v1/person-types/fields
HTTP400 CodeINVALID_FILTER_FIELD DescriptionA filter field name starts with the unsupported prefix @ or !@
HTTP400 CodeINVALID_FILTER_OPERATOR DescriptionAn unknown operator, an empty condition object, or a logical condition with $or or $and
HTTP400 CodeINVALID_DUPLICATE_FILTER_FIELD DescriptionTwo conditions resolve to the same filter condition. Provide only one
HTTP400 CodeINVALID_SORT_FIELD DescriptionSorting uses a forbidden name: __proto__, constructor, or prototype
HTTP400 CodeUNKNOWN_SORT_FIELD DescriptionSorting by an unknown field
HTTP400 CodeINVALID_SORT_DIRECTION DescriptionThe sort direction is not one of asc, desc, ASC, DESC, 1, -1
HTTP400 CodeINVALID_FILTER DescriptionThe filter is not an object or a JSON string containing an object, or the two filter forms are mixed
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the sale scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeTOKEN_MISSING DescriptionNo Bitrix24 access tokens are configured

For the full list of common API errors, see Error codes.

See also