A valid request URL is required to generate request examples{
"documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"title": "<string>",
"enforcement": "required",
"archived_at": "2023-11-07T05:31:56Z",
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"versions": 123,
"acceptances": 123,
"current_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"summary": "<string>",
"effective_at": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z",
"requires_reacceptance": true,
"acceptances": 123
},
"draft": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"summary": "<string>",
"requires_reacceptance": true,
"updated_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}List legal documents
Requires legal:manage — reads included. An unpublished version is a legal position you have not taken yet (an arbitration clause being considered, a subprocessor about to be named), and no wider permission shows it.
Archived documents are listed and marked: what you withdrew is part of the history you may have to explain.
Each row carries the two versions a screen has to name, and both keys are always present, null when there is none — current_version is the one in force right now (published, and its effective date reached) and draft is the unpublished one, of which there is at most one per document. acceptances on the row is every agreement this document ever collected; acceptances inside current_version is how many people agreed to those words, which is the number worth showing.
A valid request URL is required to generate request examples{
"documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"title": "<string>",
"enforcement": "required",
"archived_at": "2023-11-07T05:31:56Z",
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"versions": 123,
"acceptances": 123,
"current_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"summary": "<string>",
"effective_at": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z",
"requires_reacceptance": true,
"acceptances": 123
},
"draft": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"summary": "<string>",
"requires_reacceptance": true,
"updated_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Query Parameters
Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.
live, test Response
The documents, in circulation first.
Show child attributes
Show child attributes