Terms of Service

Get the calling user's Terms of Service status

Changed on

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

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/terms_of_service/status
  • Auth
    HTTP bearer

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": {
    "product_type": "branded_calling",
    "current_terms_version": "v1.1.0",
    "agreed_version": "v1.0.0",
    "agreed_at": "2025-07-10T10:30:00Z",
    "agreement_required": true
  }
}

Changes