Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const agreementListResponse of client.termsOfService.agreements.list()) { console.log(agreementListResponse.id); }

{ "data": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "terms_version": "v1.0.0", "version": "v1.0.0", "product_type": "branded_calling", "agreed_at": "2025-07-10T10:30:00Z", "created_at": "2025-07-10T10:30:00Z" } ], "meta": { "total_pages": 3, "total_results": 42, "page_number": 1, "page_size": 20 } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

product_type

enum<string>

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. Telnyx product the Terms of Service apply to.

Available options:

branded_calling,

number_reputation

Example:

"branded_calling"

page[number]

integer

default:1

1-based page number. Out-of-range values return an empty page with correct meta.

Required range: x >= 1

Example:

1

page[size]

integer

default:20

Items per page. Maximum 250; values above are clamped to 250.

Required range: 1 <= x <= 250

Example:

20

Response

Paginated list of agreements.

Paginated list of Terms of Service agreements for the calling user.

data

object[]

required

Show child attributes