TRANXACT.AI Help

Platform · Records & Legal Hold

Legal Holds

A matter — litigation, an audit, an investigation, a public records request, a grievance or a complaint — holds the records it may need. While a hold is active the records it reaches cannot be changed, deleted, archived or purged, and their files cannot be deleted: the database refuses, whoever asks. Name the people (employees, applicants), the document types, the dates and, if you want, only some tables. A hold is never deleted; Release ends it and both stay on record.

Type REST9 operationsBase path /api/platform/legal-holdsPublished as /api/v1/legal-holds

Download specification (OpenAPI 3.1) Screen: Legal Holds

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Platform › Legal Holds on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablegov.legal_holds · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

9 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/platform/legal-holdsList legal holds

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "hold_no": "HOL-000001",
      "matter_name": "Example",
      "reason": "litigation",
      "description": "text",
      "custodian_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "custodian_name": "Example",
      "employee_ids": [],
      "applicant_ids": [],
      "document_type_ids": [],
      "date_from": "2026-10-30",
      "date_to": "2026-10-30",
      "tables": [],
      "subject_ids": []
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/platform/legal-holds?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/legal-holds/{id}Read one legal holds

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hold_no": "HOL-000001",
  "matter_name": "Example",
  "reason": "litigation",
  "description": "text",
  "custodian_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "custodian_name": "Example",
  "employee_ids": [],
  "applicant_ids": [],
  "document_type_ids": [],
  "date_from": "2026-10-30",
  "date_to": "2026-10-30",
  "tables": [],
  "subject_ids": []
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/platform/legal-holds/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/legal-holdsCreate a legal holds

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
matter_nametextYesMatter — e.g. Smith v. Agency, or Open records request 2026-114
reasontextYesReason
Allowed: litigation audit investigation public_records_request grievance complaint
descriptiontextNoDescription
custodian_user_iduuidNoCustodian — The person answerable for the held records.
custodian_nametextNoCustodian (outside the system) — Counsel or an auditor who has no sign-in. Not the person whose records are held: name them under Employees.
employee_ids_uuidNoEmployees — Pick them, or name them by employee number (EMP-000089) or full name — a former employee too.
applicant_ids_uuidNoApplicants
document_type_ids_uuidNoDocument types — With people: only these documents of theirs. Alone: these documents of everybody.
date_fromdateNoRecords made from
date_todateNoRecords made to
tables_textNoOnly these tables — Empty = every table a hold can reach (see Hold Coverage).
subject_ids_uuidNoSubject ids
placed_byuuidNoPlaced by

Sample body

{
  "matter_name": "Example",
  "reason": "litigation",
  "description": "text",
  "custodian_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "custodian_name": "Example",
  "employee_ids": []
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hold_no": "HOL-000001",
  "matter_name": "Example",
  "reason": "litigation",
  "description": "text",
  "custodian_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "custodian_name": "Example",
  "employee_ids": [],
  "applicant_ids": [],
  "document_type_ids": [],
  "date_from": "2026-10-30",
  "date_to": "2026-10-30",
  "tables": [],
  "subject_ids": []
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/legal-holds" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"matter_name":"Example","reason":"litigation","description":"text","custodian_user_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","custodian_name":"Example","employee_ids":[]}'
PUT/api/platform/legal-holds/{id}Change a legal holds

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
matter_nametextYesMatter — e.g. Smith v. Agency, or Open records request 2026-114
reasontextYesReason
Allowed: litigation audit investigation public_records_request grievance complaint
descriptiontextNoDescription
custodian_user_iduuidNoCustodian — The person answerable for the held records.
custodian_nametextNoCustodian (outside the system) — Counsel or an auditor who has no sign-in. Not the person whose records are held: name them under Employees.
employee_ids_uuidNoEmployees — Pick them, or name them by employee number (EMP-000089) or full name — a former employee too.
applicant_ids_uuidNoApplicants
document_type_ids_uuidNoDocument types — With people: only these documents of theirs. Alone: these documents of everybody.
date_fromdateNoRecords made from
date_todateNoRecords made to
tables_textNoOnly these tables — Empty = every table a hold can reach (see Hold Coverage).
subject_ids_uuidNoSubject ids
placed_byuuidNoPlaced by

Sample body

{
  "matter_name": "Example",
  "reason": "litigation"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hold_no": "HOL-000001",
  "matter_name": "Example",
  "reason": "litigation",
  "description": "text",
  "custodian_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "custodian_name": "Example",
  "employee_ids": [],
  "applicant_ids": [],
  "document_type_ids": [],
  "date_from": "2026-10-30",
  "date_to": "2026-10-30",
  "tables": [],
  "subject_ids": []
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/platform/legal-holds/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"matter_name":"Example","reason":"litigation"}'
DELETE/api/platform/legal-holds/{id}Delete a legal holds

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/platform/legal-holds/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/legal-holds/choices/{kind}Choices

Path parameters

NameTypeDescription
kindstring (uuid)The record's kind, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/legal-holds/choices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/legal-holds/{id}/releaseRelease

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

note*, reason; reason one of litigation|audit|investigation|public_records_request|grievance|complaint

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/legal-holds/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note":"value","reason;":"value"}'
POST/api/platform/legal-holds/{id}/reportReport

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/legal-holds/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/report" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/legal-holds/{id}/exportExport

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

include_files

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/legal-holds/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/export" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"include_files":"value"}'

Data model

Every field of a legal holds, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
hold_notextread onlyHold no
matter_nametextread, writeMatter — e.g. Smith v. Agency, or Open records request 2026-114
reasontextread, writeReason
Allowed: litigation audit investigation public_records_request grievance complaint
descriptiontextread, writeDescription
custodian_user_iduuidread, writeCustodian — The person answerable for the held records.
custodian_nametextread, writeCustodian (outside the system) — Counsel or an auditor who has no sign-in. Not the person whose records are held: name them under Employees.
employee_ids_uuidread, writeEmployees — Pick them, or name them by employee number (EMP-000089) or full name — a former employee too.
applicant_ids_uuidread, writeApplicants
document_type_ids_uuidread, writeDocument types — With people: only these documents of theirs. Alone: these documents of everybody.
date_fromdateread, writeRecords made from
date_todateread, writeRecords made to
tables_textread, writeOnly these tables — Empty = every table a hold can reach (see Hold Coverage).
subject_ids_uuidread, writeSubject ids
statustextread onlyStatus
placed_byuuidread, writePlaced by
placed_attimestamp with time zoneread onlyPlaced at
released_byuuidread onlyReleased by
released_attimestamp with time zoneread onlyReleased at
release_notetextread onlyRelease note
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › Legal Holds for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.