List the calling user's Terms of Service agreements
Returns the Terms of Service agreements the authenticated user has on file. Each entry records the version agreed to and when. Most users only have one agreement per product, but if the ToS is updated and the user re-agrees a new entry is added.
Results are paginated with the standard page[number] / page[size] parameters; the response uses the standard {data, meta} JSON:API envelope.
By default this returns agreements for all products the user has agreed to. Pass the product_type query parameter to scope the result to a single product.
Query parameters
Telnyx product the Terms of Service apply to.
Optional filter. Omit to list the user's agreements for every product (branded_calling and number_reputation); pass a value to return only that product's agreements.
1-based page number. Out-of-range values return an empty page with correct meta.
Items per page. Maximum 250; values above are clamped to 250.
Response
Paginated list of agreements.
Example response
{
"data": [
{
"agreed_at": "2025-07-10T10:30:00Z",
"created_at": "2025-07-10T10:30:00Z",
"id": "550e8400-e29b-41d4-a716-446655440000",
"product_type": "branded_calling",
"terms_version": "v1.0.0",
"version": "v1.0.0"
}
],
"meta": {
"page_number": 1,
"page_size": 20,
"total_pages": 3,
"total_results": 42
}
}