A page of the location versions this company's edits and removals retired

GET /companies/{companyId}/locations/retired

A page of the location versions this company's edits and removals retired, most recently retired first — off the record, which carries the active locations only, and kept because an order may have pinned one.

limit is 1–200 (50 when omitted); page with offset. 404 CompanyNotFound.

Access

Requires companies:read.

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

AI agent tool

Agents call this as crm_company_retired_locations (CRM: Company retired locations), in the crm toolset. It only reads.

Connecting an agent: AI agents.

Example

curl

curl -X GET 'https://crm.getmanifold.io/companies/cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d/locations/retired?limit=50' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://crm.getmanifold.io/companies/cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d/locations/retired?limit=50", {
  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": "cloc_01a15889-fc20-7d4e-9f50-6b7c8d9e0f1a",
      "companyId": "cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d",
      "location": {
        "id": "cloc_01a15889-fc20-7d4e-9f50-6b7c8d9e0f1a",
        "name": "Old Fremantle depot",
        "shippingAddress": {
          "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"
        },
        "phone": "+61 8 9430 0000",
        "catalogIds": [],
        "retired": true
      },
      "retiredAt": "2026-10-20T10:15:00.000Z"
    }
  ],
  "total": 1,
  "limit": 50,
  "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.

`404`

Refusal	What it means	What to do
`CompanyNotFound` companyId	No such record in this organization.	Check the id in the path or the body.

`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.