API referenceCompliance Clients & Projects

Get a compliance client

gethttps://api.expiryedge.com/v1/getComplianceClient
any role (admin, editor or viewer)60/min
Request
curl 'https://api.expiryedge.com/v1/getComplianceClient?id=cc_7Rt2vQ' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Response
{
  "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 403 when the record belongs to another organization.

Query parameters

  • idstringrequired
    Client id.

Returns

200
The compliance client.
  • namestring
    Required on create; cannot be blank on update.
  • primaryContactNamestring
  • emailstring
  • phonestring
  • websitestring
  • addressstring
  • industrystring
  • statusstring
    Any other value is stored as Active.
    AllowedActiveInactive
  • notesstring
  • customFieldsmap of string
    Free-form key/value pairs. Keys are trimmed; values are stored as strings.
  • idstringread-only
  • isArchivedbooleanread-only
  • archivedAtstring | nullread-only
    format: date-time
  • organization_idstringread-only
  • user_idstringread-only
    Creator user id.
  • createdAtstringread-only
    format: date-time
  • updatedAtstringread-only
    format: date-time

Errors

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
403
Authenticated, but your role or organization does not allow this action.
404
The record does not exist or is not in your organization.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.