API-ReferenzCompliance Clients & Projects

List compliance catalog entries

gethttps://api.expiryedge.com/v1/getAllCompliances
any role (admin, editor or viewer)60/min
Anfrage
curl 'https://api.expiryedge.com/v1/getAllCompliances?includeArchived=true' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Antwort
[
  {
    "id": "cm_9Pq4zR",
    "name": "HIPAA Security Risk Assessment",
    "description": "Annual security risk analysis required under the HIPAA Security Rule.",
    "category": "Data Privacy",
    "customCategory": "",
    "renewalFrequency": "Annually",
    "notes": "Keep the signed report for six years.",
    "status": "Active",
    "customFields": {
      "regulator": "HHS OCR"
    },
    "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 compliance catalog entries, 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 compliance catalog entries.
  • namestring
    Required on create; cannot be blank on update.
  • descriptionstring
  • categorystring
    Any other value is stored as Other.
    ErlaubtData PrivacySafetyFinancialEnvironmentalLaborQualitySecurityRegulatoryOther
  • customCategorystring
    Only kept when category is Other.
  • renewalFrequencystring
    Any other value is stored as One-Time.
    ErlaubtOne-TimeMonthlyQuarterlyAnnuallyBiennially
  • notesstring
  • statusstring
    Any other value is stored as Active.
    ErlaubtActiveInactive
  • 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

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.