Sign in

v51

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

Get a route

Returns the details of the route for the given ID.

get/routes/{id}

Path parameters

idstring required

The route's ID.

Response

The route details.

idstring uuid

The unique identifier of the route. Returned from the POST /routes or GET /routes response.

customer_idstring uuid

The unique identifier of the customer who owns this route. Returned from the GET /customers response.

namestring

The name of the route.

detailstring

The details about the route.

provider_idstring uuid

The unique identifier of the provider used for this route. Returned from the GET /providers response.

priorityinteger

The priority of the route, used for routing decisions.

targetstring

The target destination for the route (e.g., country code or 'all').

tm_createstring date-time

The creation timestamp.

tm_updatestring date-time

The last update timestamp.

tm_deletestring date-time

The deletion timestamp.

Example response

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