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

Get a requisite link

GET /v1/requisite-links/:entityTypeId/:entityId

Returns a specific requisite link by the owner identifier pair.

Parameters

Parameter Type Required Description
entityTypeId (path) number yes Owner type: 2 — deal, 31 — invoice
entityId (path) number yes Owner ID. Source: GET /v1/deals or GET /v1/invoices

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/requisite-links/2/3773" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth app

Terminal 
curl "https://vibecode.bitrix24.com/v1/requisite-links/2/3773" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const entityTypeId = 2
const entityId = 3773

const res = await fetch(
  `https://vibecode.bitrix24.com/v1/requisite-links/${entityTypeId}/${entityId}`,
  {
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
    },
  }
)

const { success, data } = await res.json()
console.log('Requisite:', data.REQUISITE_ID)

JavaScript — OAuth app

javascript 
const entityTypeId = 2
const entityId = 3773

const res = await fetch(
  `https://vibecode.bitrix24.com/v1/requisite-links/${entityTypeId}/${entityId}`,
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)

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

Response fields

Field Type Description
success boolean Always true on success
data object Link object
data.ENTITY_TYPE_ID number Owner type: 2 — deal, 31 — invoice
data.ENTITY_ID number Owner ID
data.REQUISITE_ID string Linked requisite ID; "0" — not linked. Source: GET /v1/requisites
data.BANK_DETAIL_ID string Linked bank requisite ID; "0" — not linked. Source: GET /v1/bank-details
data.MC_REQUISITE_ID string Your company's requisite ID; "0" — not linked
data.MC_BANK_DETAIL_ID string Your company's bank requisite ID; "0" — not linked

Response example

JSON 
{
  "success": true,
  "data": {
    "ENTITY_TYPE_ID": 2,
    "ENTITY_ID": 3773,
    "REQUISITE_ID": "45",
    "BANK_DETAIL_ID": "0",
    "MC_REQUISITE_ID": "0",
    "MC_BANK_DETAIL_ID": "0"
  }
}

Error response example

404 — link not found:

JSON 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "No requisite link for entityTypeId=2, entityId=999"
  }
}

Errors

HTTP Code Description
404 NOT_FOUND No link found for the given entityTypeId and entityId
403 SCOPE_DENIED API key lacks the crm scope
401 TOKEN_MISSING X-Api-Key not provided

Full list of common API errors — Errors.

Known specifics

A link has no separate numeric id. It is identified by the owner value pair: entityTypeId and entityId — both passed in the path.

Mixed types in the response. ENTITY_TYPE_ID and ENTITY_ID are returned as numbers, while the other identifiers — REQUISITE_ID, BANK_DETAIL_ID, MC_REQUISITE_ID, MC_BANK_DETAIL_ID — as strings.

A value of "0" means no link. For REQUISITE_ID, BANK_DETAIL_ID, MC_REQUISITE_ID, MC_BANK_DETAIL_ID the string "0" means the corresponding requisite is not linked, not that an object with ID 0 is linked.

See also