Developers
Legal terms7

List legal term acceptances

GET/legal-terms/{legal_term_id}/acceptances

Lists the acceptances recorded for a legal term. Acceptances are recorded when users accept the term and cannot be created through the API.

The collection can be filtered by user and by acceptance date. When the credentials are restricted to specific users, only acceptances by those users are returned.

The proof object is included only when the credentials have the legal_terms.read_proof permission.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

legal_term_id*string

Public ID of the legal term, prefixed with trm_.

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
user_id?string

Only acceptances by the user with this public ID.

accepted_after?string

Only items accepted after this date and time (ISO 8601).

Formatdate-time
accepted_before?string

Only items accepted before this date and time (ISO 8601).

Formatdate-time

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/legal-terms/string/acceptances"
{  "data": [    {      "accepted_at": "2019-08-24T14:15:22Z",      "id": "string",      "legal_term_id": "string",      "links": {        "self": "string"      },      "object": "term_acceptance",      "proof": {        "ip": "string",        "user_agent": "string"      },      "user_id": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Update a legal term PATCH

Replaces the body of a legal term. Setting `body` to `null` removes the legal term; subsequent requests for it return `404`. Changing the text does not invalidate acceptances already recorded, and users are not asked to accept the term again. Send the `ETag` returned by the retrieve operation in the `If-Match` header to avoid overwriting a newer version. Legal terms of replicated accounts and replicated products are read-only.

Retrieve a legal term acceptance GET

Retrieves an acceptance of a legal term by its public ID. This is the canonical location of every acceptance, including those returned in a user's acceptance history. The `proof` object, containing the IP address and user agent recorded at acceptance, is included only when the credentials have the `legal_terms.read_proof` permission. Otherwise, it is omitted from the response.