Developers
Legal terms

List legal terms

GET/legal-terms

Lists the configured legal terms: at most one for the platform and one per product. The collection can be filtered by scope and product.

The term body is not included in the collection; use the retrieve operation to obtain it. When the credentials are restricted to specific legal terms, only those terms are returned.

Returns all matching legal terms in a single response while preserving the standard collection response format.

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

scope?string

Value in

  • "platform"
  • "product"
product_id?string

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

curl -X GET "https://example.com/legal-terms"
{  "data": [    {      "acceptances_count": 0,      "body": {        "blocks": [          {}        ]      },      "id": "string",      "object": "legal_term",      "product_id": "string",      "revision": "string",      "scope": "platform",      "title": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Legal terms

Legal terms in API v3: list legal terms, create a legal term, retrieve a legal term, update a legal term, list legal term acceptances, retrieve a legal term acceptance, list a user's legal term acceptances.

Create a legal term POST

Configures the legal term for a scope. There is at most one legal term for the platform and one per product, and legal terms are not versioned. The `product` scope requires `product_id`. If the scope already has a legal term, the request is rejected; use the update operation to change its text. Legal terms of replicated accounts and replicated products are read-only.