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

This method is rolling out in crm 26.2100.0. It is not available in every Bitrix24 account. If the method is not enabled yet, the API returns 422 METHOD_NOT_YET_AVAILABLE.

List end-to-end analytics sources

GET /v1/crm-tracking/sources

List end-to-end analytics sources used to configure attribution of customer interactions.

Requires the crm scope, the crm-tracking-v3 flag, and the feature enabled in the Bitrix24 account. READONLY keys can read this resource.

Parameters

Parameter Type Default Description
Parameterlimit (query) Typenumber Default50 DescriptionPage size, an integer from 1 to 500.
Parameteroffset (query) Typenumber Default0 DescriptionNumber of records to skip, a nonnegative integer.
Parameterarchived (query) Typeboolean Defaultfalse Descriptiontrue lists archived sources. Omit it or pass false to list active sources and unconfigured built-in sources.

Pagination: each request returns one page. Increase offset by limit to request the next page. Sorting and additional filters are not supported.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/crm-tracking/sources?limit=50&offset=0" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/crm-tracking/sources?limit=50&offset=0" \
  -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/crm-tracking/sources?limit=50&offset=0', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const result = await res.json()
console.log(result)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/crm-tracking/sources?limit=50&offset=0', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const result = await res.json()
console.log(result)

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue
Fielddata Typearray DescriptionSources.
Fielddata[].id Typenumber or null DescriptionSource ID. null for a built-in source without saved configuration.
Fielddata[].code Typestring or null DescriptionBuilt-in source code. null for a custom source.
Fielddata[].kind Typestring Descriptionown for a custom source, builtIn for a built-in source.
Fielddata[].name Typestring DescriptionSource name.
Fielddata[].color Typestring or null DescriptionSource color.
Fielddata[].isActive Typeboolean DescriptionWhether the source is active.
Fielddata[].isConfigurable Typeboolean DescriptionWhether the source can be configured.
Fielddata[].isConfigured Typeboolean DescriptionWhether source configuration has been saved.
Fielddata[].refDomains Typestring[] DescriptionReferring domains.
Fielddata[].utmSources Typestring[] DescriptionValues of the utm_source parameter.
Fieldmeta.limit Typenumber DescriptionRequested page size.
Fieldmeta.offset Typenumber DescriptionRequested offset.

Response example

Example page structure containing a custom source and a built-in source.

JSON 
{
  "success": true,
  "data": [
    {
      "id": 2,
      "code": null,
      "kind": "own",
      "name": "VIBE-PROBE source",
      "color": "#55d0e0",
      "isActive": true,
      "isConfigurable": true,
      "isConfigured": true,
      "refDomains": [],
      "utmSources": [
        "vibeprobe"
      ]
    },
    {
      "id": null,
      "code": "google",
      "kind": "builtIn",
      "name": "Google Ads",
      "color": "#3889db",
      "isActive": true,
      "isConfigurable": true,
      "isConfigured": false,
      "refDomains": [],
      "utmSources": []
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0
  }
}

Error response example

400 — unsupported query parameter:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown query parameter"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionInvalid pagination or archived value.
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionAn unsupported query parameter, filter, or sort was supplied.
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the crm scope.
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured tokens.
HTTP422 CodeMETHOD_NOT_YET_AVAILABLE DescriptionThe flag is off or the method is not enabled in the account. error.release is crm 26.2100.0.
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 returned an invalid response.

Other Bitrix24 refusal codes, HTTP statuses, and messages are preserved. For the full list of common API errors, see Errors.

See also