v53

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-041,1941,9384.1 MB

Get the calling user's Terms of Service status

Returns whether the authenticated user has agreed to the current Terms of Service for the product given by product_type. Used during onboarding to decide whether to prompt the user with the ToS dialog before continuing.

agreement_required: true means the user has not yet agreed (or has agreed to an outdated version) and must agree before using that product's endpoints.

get/terms_of_service/status

Query parameters

product_type'branded_calling' | 'number_reputation'

Telnyx product the Terms of Service apply to.

Example:branded_calling

Which product's ToS to check. Defaults to branded_calling.

Response

Status.

Example response

{
  "data": {
    "agreed_at": "2025-07-10T10:30:00Z",
    "agreed_version": "v1.0.0",
    "agreement_required": true,
    "current_terms_version": "v1.1.0",
    "product_type": "branded_calling"
  }
}