v51

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

Route

List routes

Returns a list of routes for the given customer with pagination.

get/routes

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.

customer_idstring

target customer id

Response

A list of routes.

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": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "name": "US Outbound Route",
      "detail": "Routes calls to US numbers via primary provider",
      "provider_id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",
      "priority": 1,
      "target": "1",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-16T14:20:00.000000Z",
      "tm_delete": "2026-01-17T18:45:00.000000Z"
    }
  ]
}