GET/v1/export/clients

Export Clients

Exports the client workspaces connected to your agency (workspaces whose parent is your verified agency workspace), each with its latest stored IMPRS score. Cross-workspace reads are gated entirely on your verified client hierarchy, so only your own clients are ever returned. Authorization is tied to the API key owner. The owning account must be on the Agency plan or above, and the key must carry the "read" scope.

Bearer token required. "read" scope. Minimum plan: Agency (the key owner is tier-checked directly).

Request
curl -X GET "https://api.amilere.com/v1/export/clients" \
  -H "Authorization: Bearer prism_YOUR_API_KEY"
Response (200 OK)
{
  "scope": {
    "workspaceId": "ws_agency_001",
    "workspaceName": "Northwind Agency"
  },
  "count": 2,
  "clients": [
    {
      "workspaceId": "ws_client_044",
      "name": "Acme DTC",
      "type": "brand",
      "orgType": "client",
      "isWhiteLabeled": true,
      "prismScore": 612,
      "imprsScore": 612,
      "grade": "strong",
      "scoredAt": "2026-06-20T11:00:00Z"
    },
    {
      "workspaceId": "ws_client_051",
      "name": "Lumen Skincare",
      "type": "brand",
      "orgType": "client",
      "isWhiteLabeled": false,
      "prismScore": 488,
      "imprsScore": 488,
      "grade": "moderate",
      "scoredAt": "2026-06-18T14:10:00Z"
    }
  ]
}

Error Codes

401

Unauthorized

Missing, malformed, expired, or revoked API key.

403

Forbidden

Key lacks the "read" scope, or the key owner is not on an Agency plan or above.

429

Rate Limited

Per-key rate limit exceeded. Honour the Retry-After header.