People and companies as one list of pickable rows

GET /parties

People and companies as one list of pickable rows — id, kind, display name, roles, status — the shape every picker searches and every document resolves its party ids through.

q narrows by name or email (case-insensitive substring), kind and role to comma-separated sets; by default only active rows are listed, name-ordered. ids resolves exactly those ids (comma-separated, up to 200) in any status, so a purchase order that named a company since archived, or an order whose customer was erased, still renders — the latter as "Erased person". total counts every match; limit defaults to 100 and is capped at 1000; page with offset.

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_parties (CRM: List parties), in the crm toolset. It only reads.

Connecting an agent: AI agents.

Example

curl

curl -X GET 'https://crm.getmanifold.io/parties?q=harbour&kind=person%2Ccompany&role=customer&limit=20' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://crm.getmanifold.io/parties?q=harbour&kind=person%2Ccompany&role=customer&limit=20", {
  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": "cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d",
      "kind": "company",
      "name": "Harbour Ceramics Pty Ltd",
      "roles": [
        "customer"
      ],
      "status": "active",
      "catalogIds": [
        "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e"
      ]
    },
    {
      "id": "psn_01a1588a-0c41-7d2e-9a10-3b5c6d7e8f90",
      "kind": "person",
      "name": "Priya Raman",
      "email": "priya.raman@harbourceramics.example",
      "roles": [
        "customer"
      ],
      "status": "active",
      "catalogIds": []
    }
  ],
  "total": 2,
  "limit": 20,
  "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.

Used in

A person, a supplier, and a right-to-erasure request, step 5: Search the parties a purchase order may name
A person, a supplier, and a right-to-erasure request, step 13: A document that named them still renders