API-ReferenzCompliance Clients & Projects

List clients

gethttps://api.expiryedge.com/v1/getAllComplianceClients
any role (admin, editor or viewer)60/min
Anfrage
curl 'https://api.expiryedge.com/v1/getAllComplianceClients?includeArchived=true' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Antwort
[
  {
    "id": "cc_7Rt2vQ",
    "name": "Northwind Dental",
    "primaryContactName": "Priya Shah",
    "email": "priya@northwinddental.example",
    "phone": "+1 555 0142",
    "website": "https://northwinddental.example",
    "address": "12 Harbor Way, Portland, OR",
    "industry": "Healthcare",
    "status": "Active",
    "notes": "Annual license audit in October.",
    "customFields": {
      "account_manager": "Dana Lee"
    },
    "isArchived": false,
    "archivedAt": null,
    "organization_id": "org_northwind",
    "user_id": "u_71bXq",
    "createdAt": "2026-09-27T14:05:00.000Z",
    "updatedAt": "2026-09-27T14:05:00.000Z"
  }
]

Returns all of the organization's clients, newest first; archived records are excluded unless includeArchived=true. Unbounded (no pagination).

Query-Parameter

  • includeArchivedstring
    Set to true to include archived records.
    Erlaubttruefalse

Rückgabe

200
Array of clients.
  • namestring
    Required on create; cannot be blank on update.
  • primaryContactNamestring
  • emailstring
  • phonestring
  • websitestring
  • addressstring
  • industrystring
  • statusstring
    Any other value is stored as Active.
    ErlaubtActiveInactive
  • notesstring
  • customFieldsmap of string
    Free-form key/value pairs. Keys are trimmed; values are stored as strings.
  • idstringschreibgeschützt
  • isArchivedbooleanschreibgeschützt
  • archivedAtstring | nullschreibgeschützt
    format: date-time
  • organization_idstringschreibgeschützt
  • user_idstringschreibgeschützt
    Creator user id.
  • createdAtstringschreibgeschützt
    format: date-time
  • updatedAtstringschreibgeschützt
    format: date-time

Fehler

401
Missing, expired or invalid bearer token.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.