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

Get address

GET /v1/addresses/:typeId/:entityTypeId/:entityId

Returns a single address by a composite key of three parameters: address type, owner type and owner ID.

Parameters

Parameter Type Required Description
typeId (path) number yes Address type: 1 — registered, 4 — primary, 6 — postal, 8 — delivery, 9 — actual, 11 — beneficiary, 13 — warehouse
entityTypeId (path) number yes Owner type: 8 — requisite, 3 — contact, 4 — company, 1 — lead
entityId (path) number yes ID of the address owner. For a requisite — the ID from GET /v1/requisites

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/addresses/1/3/9" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth app

Terminal 
curl "https://vibecode.bitrix24.com/v1/addresses/1/3/9" \
  -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/addresses/1/3/9', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('City:', data.city, 'Postal code:', data.postalCode)

JavaScript — OAuth app

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/addresses/1/3/9', {
  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 Address object
data.typeId number Address type
data.entityTypeId number Owner type
data.entityId number Owner ID
data.address1 string | null Street, building, block, structure
data.address2 string | null Apartment, office
data.city string | null City
data.postalCode string | null Postal code
data.region string | null District
data.province string | null Province
data.country string | null Country
data.countryCode string | null Country code
data.locAddrId number Location address identifier
data.anchorTypeId number Type of the entity the address is linked to (read-only)
data.anchorId number ID of the entity the address is linked to (read-only)

Response example

JSON 
{
  "success": true,
  "data": {
    "typeId": 1,
    "entityTypeId": 3,
    "entityId": 9,
    "address1": null,
    "address2": null,
    "city": null,
    "postalCode": null,
    "region": null,
    "province": null,
    "country": null,
    "countryCode": null,
    "locAddrId": 0,
    "anchorTypeId": 3,
    "anchorId": 9
  }
}

Error response example

404 — address not found:

JSON 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Address (typeId=1, entityTypeId=3, entityId=99999999) not found"
  }
}

Errors

HTTP Code Description
404 NOT_FOUND An address with this composite key was not found
400 INVALID_COMPOSITE_KEY One of the path parameters is not a positive integer
403 SCOPE_DENIED The API key lacks the crm scope
401 TOKEN_MISSING The API key has no configured tokens

Full list of common API errors — Errors.

See also