A read-only API for the partners an agency invites.

Check the connection

GET /connection needs clients:read

Confirms the key works and shows what it may do: its name, test or live mode, scopes and expiry. No client data. Takes no parameters.

{
  "data": {
    "name": "Example partner sync",
    "mode": "TEST",
    "scopes": [
      "clients:read",
      "contacts:read",
      "policies:read"
    ],
    "expiresAt": "2026-12-31T00:00:00.000Z",
    "readOnly": true,
    "version": "v1"
  }
}

List clients

GET /clients needs clients:read

The clients the agency selected for this key, ordered by id. Search narrows the list; it never widens it.

• q (query) — Optional search, up to 100 characters: company name or DBA (any case), or part of a USDOT or MC number.
• limit (query) — Rows per page, 1–50. Default 25.
• cursor (query) — The nextCursor from the previous page. Omit it for the first page.

{
  "data": [
    {
      "id": "3f2a9c1e-7b4d-4e8a-9c21-5d6e7f8a9b01",
      "companyName": "Sample Haulers LLC",
      "dba": "Sample Freight",
      "usdot": "1234567",
      "mc": "765432",
      "relationship": "CLIENT",
      "lifecycle": "BOUND",
      "newBusinessStage": null,
      "renewalStage": "WAITING_CLIENT",
      "renewalDate": "2027-03-01T00:00:00.000Z",
      "updatedAt": "2026-10-20T15:04:05.000Z",
      "isDemo": true
    },
    {
      "id": "3f2a9c1e-7b4d-4e8a-9c21-5d6e7f8a9b02",
      "companyName": "Example Express Inc",
      "dba": null,
      "usdot": "2345678",
      "mc": null,
      "relationship": "PROSPECT",
      "lifecycle": "QUOTING",
      "newBusinessStage": "QUOTING",
      "renewalStage": null,
      "renewalDate": null,
      "updatedAt": "2026-10-20T15:04:05.000Z",
      "isDemo": true
    }
  ],
  "pagination": {
    "limit": 2,
    "hasMore": true,
    "nextCursor": "3f2a9c1e-7b4d-4e8a-9c21-5d6e7f8a9b02"
  }
}

Get one client

GET /clients/{id} needs clients:read

One selected client. A client that is not selected for this key, archived, or in the other mode answers 404. Takes no query parameters.

• id (path) — A client id returned by /clients.

{
  "data": {
    "id": "3f2a9c1e-7b4d-4e8a-9c21-5d6e7f8a9b01",
    "companyName": "Sample Haulers LLC",
    "dba": "Sample Freight",
    "usdot": "1234567",
    "mc": "765432",
    "relationship": "CLIENT",
    "lifecycle": "BOUND",
    "newBusinessStage": null,
    "renewalStage": "WAITING_CLIENT",
    "renewalDate": "2027-03-01T00:00:00.000Z",
    "updatedAt": "2026-10-20T15:04:05.000Z",
    "isDemo": true
  }
}

List a client’s contacts

GET /clients/{id}/contacts needs contacts:read

Names, roles, phone numbers and emails. A client whose contact was only ever typed on the client record returns that one person with id null and source "legacy".

• id (path) — A client id returned by /clients.
• limit (query) — Rows per page, 1–50. Default 25.
• cursor (query) — The nextCursor from the previous page. Omit it for the first page.

{
  "data": [
    {
      "id": "8b1c2d3e-4f50-4a6b-8c7d-9e0f1a2b3c4d",
      "name": "Pat Example",
      "role": "OWNER",
      "title": "Owner",
      "phone": "(555) 010-0199",
      "email": "pat@example.com",
      "isPrimary": true
    }
  ],
  "pagination": {
    "limit": 25,
    "hasMore": false,
    "nextCursor": null
  }
}

List a client’s policy summaries

GET /clients/{id}/policies needs policies:read

Each policy with its newest term: status, dates, insurer, writing carrier and coverage codes (up to 50; coverageTruncated says if there were more). No premiums, payments, limits or documents. An insurer not on file is null.

• id (path) — A client id returned by /clients.
• limit (query) — Rows per page, 1–50. Default 25.
• cursor (query) — The nextCursor from the previous page. Omit it for the first page.

{
  "data": [
    {
      "id": "c4d5e6f7-0819-4a2b-9c3d-4e5f6a7b8c9d",
      "status": "ACTIVE",
      "primaryLine": "AL",
      "updatedAt": "2026-10-18T09:30:00.000Z",
      "latestTerm": {
        "status": "ACTIVE",
        "effectiveDate": "2026-03-01T00:00:00.000Z",
        "expirationDate": "2027-03-01T00:00:00.000Z",
        "insurerName": "Example Mutual",
        "writingCarrier": "Example Specialty Insurance Co",
        "coverageCodes": [
          "AL",
          "MTC",
          "PD"
        ],
        "coverageTruncated": false
      }
    }
  ],
  "pagination": {
    "limit": 25,
    "hasMore": false,
    "nextCursor": null
  }
}