List compliance clients

Vorschau

gethttps://api.expiryedge.com/v2/compliance-clients

any member of an organization60/min

Anfrage

curl 'https://api.expiryedge.com/v2/compliance-clients?limit=50' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"

Antwort

{
  "data": [
    {
      "name": "Example name",
      "primary_contact_name": "Example name",
      "email": "name@example.com",
      "phone": "+15555550123",
      "website": "string",
      "address": "string",
      "industry": "string",
      "status": "Active",
      "notes": "string",
      "custom_fields": {}
    }
  ],
  "next_cursor": "string",
  "has_more": true
}

Ordered by id, cursor-paginated; archived and active clients unless archived is given.

Query-Parameter

archivedstring
Erlaubttruefalse
statusstring
ErlaubtActiveInactive
sortstring
Erlaubtid
cursorstring
Opaque next_cursor from the previous page. Only valid with the same sort.
limitinteger
Page size, 1-100 (values above 100 are clamped; default 50).
Standard 50min: 1 · max: 100

Rückgabe

200

A page of clients.

dataarray of objectserforderlich
next_cursorstring | nullerforderlich
has_morebooleanerforderlich

Fehler

`400`	Invalid parameters or body (`VALIDATION_FAILED`; `details` names the fields).
`401`	Missing, invalid or expired token (`UNAUTHORIZED`).
`403`	Your role can't do this, or your account has no organization (`FORBIDDEN`).
`405`	Wrong HTTP method for this path; the `Allow` header lists the valid ones.
`429`	Too many requests for this endpoint from your IP. Wait `Retry-After` seconds.