v51

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

Outplan

Retrieve a list of outplans.

Retrieves a paginated list of outplans based on the provided parameters.

get/outplans

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 outplans.

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": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "name": "Standard Outbound Plan",
      "detail": "Default outbound dialing plan for campaigns",
      "source": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "dial_timeout": 30000,
      "try_interval": 60000,
      "max_try_count_0": 3,
      "max_try_count_1": 2,
      "max_try_count_2": 1,
      "max_try_count_3": 1,
      "max_try_count_4": 1,
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}