v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Customer

Gets a list of customers.

Retrieves a paginated list of customers.

get/customers

Query parameters

page_sizeinteger

Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

Response

A list of customers.

next_page_tokenstring

Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.

Example response

{
  "result": [
    {
      "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "name": "Acme Corporation",
      "detail": "Enterprise customer account",
      "email": "admin@acme.com",
      "phone_number": "+14155551234",
      "address": "123 Main St, San Francisco, CA 94105",
      "webhook_method": "POST",
      "webhook_uri": "https://api.acme.com/webhooks/voipbin",
      "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
      "metadata": {
        "rtp_debug": true
      },
      "email_verified": true,
      "status": "active",
      "identity_verification_status": "none",
      "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z",
      "terms_agreed_version": "2026-01-01",
      "terms_agreed_ip": "203.0.113.42"
    }
  ]
}