Resolve address versions a document pinned

GET /addresses

Resolve address versions a document pinned — a person's adr_ addresses or a company's cloc_ locations, comma-separated, up to 200 — to the postal address exactly as it read when pinned.

Addresses are immutable: editing one in the CRM retires the version (retired: true, supersededBy naming its replacement) and mints a new id, so an order keeps showing what it was placed with and can tell that the customer has since changed it. A version of an erased person resolves with address: null; an unknown id is simply absent from the page.

Access

Requires customers:read or companies:read.

Any one of these scopes is enough.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

AI agent tool

Agents call this as crm_list_addresses (CRM: List addresses), in the crm toolset. It only reads.

Connecting an agent: AI agents.

Example

curl

curl -X GET 'https://crm.getmanifold.io/addresses?ids=adr_01a1588a-0c41-7d2e-9a10-4c6d7e8f9a01%2Ccloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://crm.getmanifold.io/addresses?ids=adr_01a1588a-0c41-7d2e-9a10-4c6d7e8f9a01%2Ccloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Response · 200 · application/json

{
  "items": [
    {
      "id": "adr_01a1588a-0c41-7d2e-9a10-4c6d7e8f9a01",
      "ownerKind": "person",
      "ownerId": "psn_01a1588a-0c41-7d2e-9a10-3b5c6d7e8f90",
      "ownerName": "Priya Raman",
      "address": {
        "firstName": "Priya",
        "lastName": "Raman",
        "company": "Harbour Ceramics",
        "address1": "14 Kiln Street",
        "city": "Fremantle",
        "province": "Western Australia",
        "provinceCode": "WA",
        "country": "Australia",
        "countryCode": "AU",
        "zip": "6160"
      },
      "retired": false
    },
    {
      "id": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e",
      "ownerKind": "company",
      "ownerId": "cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d",
      "ownerName": "Harbour Ceramics Pty Ltd",
      "label": "Fremantle warehouse",
      "address": {
        "firstName": "Receiving",
        "lastName": "Dock",
        "company": "Harbour Ceramics",
        "address1": "14 Kiln Street",
        "city": "Fremantle",
        "province": "Western Australia",
        "provinceCode": "WA",
        "country": "Australia",
        "countryCode": "AU",
        "zip": "6160"
      },
      "billingAddress": {
        "company": "Harbour Ceramics Pty Ltd",
        "address1": "PO Box 412",
        "city": "Fremantle",
        "provinceCode": "WA",
        "countryCode": "AU",
        "zip": "6959"
      },
      "retired": false
    }
  ],
  "total": 2,
  "limit": 200,
  "offset": 0
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: crm-manager.openapi.json. Base URL https://crm.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`409`

Refusal	What it means	What to do
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Try again shortly.

How refusals work everywhere: Errors.