Resolve An Address Value

GET 
/v1/open-api/address/:uuid

Expand the raw value of an ADDRESS CRM field into its full country / region / district / street breakdown.

An ADDRESS field stores a composite string: "<district-or-region-uuid>||<street>". Pass that whole string (URL-encoded) as the path segment and you get the resolved address back.

This endpoint does not use the standard response envelope — the body is the address object itself. And it never fails on bad input: if the value has no || separator, or the uuid matches no district and no region, the input string is echoed back verbatim as a plain string. Check for that case rather than assuming an object.

Requires no specific grant — any valid, non-expired token is accepted.

Request

Responses

200

The resolved address, unwrapped. A value that cannot be resolved comes back as the original string instead of an object.

401

Invalid, revoked or expired token (401) — also returned when the connection was revoked or the company is blocked.

Produced by the authentication filter, so the body is a reduced envelope: no error, no requestId, and errors is null rather than []. Every cause yields the same fixed English message.

429

Rate limit of 60 requests/minute exceeded (429). Like 401, this comes from the authentication filter: reduced envelope, fixed English message, no error object and no Retry-After header.