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.

GET

terms_of_service

agreements

JavaScript

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);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.terms_of_service.agreements.list()
page = page.data[0]
print(page.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.TermsOfService.Agreements.List(context.TODO(), telnyx.TermsOfServiceAgreementListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.termsofservice.agreements.AgreementListPage;
import com.telnyx.sdk.models.termsofservice.agreements.AgreementListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        AgreementListPage page = client.termsOfService().agreements().list();
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->termsOfService->agreements->list(
    pageNumber: 1, pageSize: 20, productType: 'branded_calling'
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "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

Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.

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

meta

object

required

JSON:API pagination metadata returned with every paginated list response. Page numbering is 1-based. page_size reports the number of items actually returned in data for this page; the requested size is taken from the page[size] query parameter.

Show child attributes

JavaScript

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);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.terms_of_service.agreements.list()
page = page.data[0]
print(page.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.TermsOfService.Agreements.List(context.TODO(), telnyx.TermsOfServiceAgreementListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.termsofservice.agreements.AgreementListPage;
import com.telnyx.sdk.models.termsofservice.agreements.AgreementListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        AgreementListPage page = client.termsOfService().agreements().list();
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->termsOfService->agreements->list(
    pageNumber: 1, pageSize: 20, productType: 'branded_calling'
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "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
  }
}

Branded Calling

For AI Agents

List the calling user's Terms of Service agreements

Authorizations

Query Parameters

Response