List legal holds

⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/compliance/legal_holds

Return the organization’s legal holds.

For how this fits into a full workflow, see Compliance API.

Headers

HeaderRequiredValue
AuthorizationYesBearer <admin key>: an Admin API key (sk_admin_...) that carries the compliance:read scope (plus compliance:write for deletions and holds). Enterprise plans only. See Compliance API.
syntic-betaYes, while in previewcompliance-2026-12-01. Without it the call fails with 400 beta_required. See Versioning.

Query parameters

ParameterTypeDefaultDescription
statusstringactiveactive, released or all.
limitinteger201 to 100.
after_idstringNext page: the previous page’s last_id.
before_idstringPrevious page: the previous page’s first_id.

Response

200 OK, Content-Type: application/json

{
  "data": [
    {
      "id": "hold_01JD02A4C6E8G0J2L4N6",
      "type": "legal_hold",
      "name": "Matter 2026-117",
      "user_ids": [
        "user_01J9Y0A2C4E6G8J0L2N4"
      ],
      "kinds": [
        "chats",
        "projects",
        "code_sessions",
        "files"
      ],
      "starting_at": "2026-06-01T00:00:00Z",
      "ending_at": null,
      "status": "active",
      "created_by": "adminkey_01JC0Z2B4D6F8H0K2M4P",
      "created_at": "2026-11-05T10:00:00Z",
      "released_at": null
    }
  ],
  "has_more": false,
  "first_id": "hold_01JD02A4C6E8G0J2L4N6",
  "last_id": "hold_01JD02A4C6E8G0J2L4N6"
}
FieldTypeDescription
dataarrayThe objects on this page, newest first.
has_morebooleantrue when another page exists after this one.
first_idstring or nullPass as before_id to go back a page.
last_idstring or nullPass as after_id to get the next page.

Examples

curl -sS "https://app.syntic.ai/v1/compliance/legal_holds" \
  -H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
  -H "syntic-beta: compliance-2026-12-01"

Errors

Errors use the error envelope and carry a request_id. Codes specific to this operation:

StatustypecodeWhen
400invalid_request_errorbeta_requiredThe syntic-beta header is missing.
401authentication_errorinvalid_api_keyThe admin key is missing, unknown, revoked or expired.
403permission_erroradmin_key_requiredAn inference key was used.
403permission_errorscope_missingThe admin key lacks the compliance:read (or, for writes, compliance:write) scope.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?