API referencev2 (preview)

Get a compliance client

Preview
gethttps://api.expiryedge.com/v2/compliance-clients/{id}
any member of the client's organization60/min
Request
curl 'https://api.expiryedge.com/v2/compliance-clients/cli_123' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Response
{
  "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": {},
  "id": "cli_123",
  "organization_id": "org_123",
  "user_id": "use_123",
  "is_archived": true,
  "archived_at": "2026-10-15T09:00:00Z",
  "created_at": "2026-09-27T14:05:00.000Z"
}

Path parameters

  • idstringrequired

Returns

200
The client.
  • namestring
    max length: 200
  • primary_contact_namestring
  • emailstring
  • phonestring
  • websitestring
  • addressstring
  • industrystring
  • statusstring
    AllowedActiveInactive
  • notesstring
  • custom_fieldsmap of string
  • idstring
  • organization_idstring
  • user_idstring
  • is_archivedboolean
  • archived_atstring | null
  • created_atstring
    UTC timestamp, ISO 8601. Every v1 response uses this form, never a raw Firestore Timestamp ({_seconds, _nanoseconds}).
    format: date-time
  • updated_atstring
    UTC timestamp, ISO 8601. Every v1 response uses this form, never a raw Firestore Timestamp ({_seconds, _nanoseconds}).
    format: date-time

Errors

401
Missing, invalid or expired token (UNAUTHORIZED).
403
Your role can't do this, or your account has no organization (FORBIDDEN).
404
No such record in your organization (records in other organizations are also 404).
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.