API-ReferenzCompliance Clients & Projects

Get a compliance project

gethttps://api.expiryedge.com/v1/getComplianceProject
any role (admin, editor or viewer)60/min
Anfrage
curl 'https://api.expiryedge.com/v1/getComplianceProject?id=cp_3Mn8wX' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Antwort
{
  "id": "cp_3Mn8wX",
  "name": "Northwind Dental - 2026 License Renewals",
  "clientId": "cc_7Rt2vQ",
  "status": "In Progress",
  "startDate": "2026-09-01",
  "dueDate": "2026-10-15",
  "description": "Collect and renew all state dental licenses.",
  "owner": "Priya Shah",
  "customFields": {
    "board": "State Board of Dentistry"
  },
  "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-Parameter

  • idstringerforderlich
    Project id.

Rückgabe

200
The compliance project.
  • namestring
    Required on create; cannot be blank on update.
  • clientIdstring
    Compliance client id in your organization. Required on create.
  • statusstring
    Any other value is stored as Not Started.
    ErlaubtNot StartedIn ProgressOn HoldCompletedCancelled
  • startDatestring
    Stored as sent (not validated); the web app sends YYYY-MM-DD. Empty string when unset.
  • dueDatestring
    Stored as sent (not validated); the web app sends YYYY-MM-DD. Empty string when unset.
  • descriptionstring
  • ownerstring
    Free-text owner name.
  • 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
  • createdAtstringschreibgeschützt
    format: date-time
  • updatedAtstringschreibgeschützt
    format: date-time

Fehler

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.