v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Connections

List connections

Returns a list of your connections irrespective of type.

get/connections

Query parameters

fqdnstring

If present, connections with an fqdn that equals the given value will be returned. Matching is case-sensitive, and the full string must match.

outbound_voice_profile_idstring

Identifies the associated outbound voice profile.

Consolidated filter parameter (deepObject style). Originally: filter[connection_name], filter[fqdn], filter[outbound_voice_profile_id], filter[outbound.outbound_voice_profile_id]

{
  "outbound_voice_profile_id": "1293384261075731499"
}

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

sort'created_at' | 'connection_name' | 'active'

Example:connection_name

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul>

<li> <code>connection_name</code>: sorts the result by the <code>connection_name</code> field in ascending order. </li> <li> <code>-connection_name</code>: sorts the result by the <code>connection_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.

Response

Successful response with a list of connections.

Example response

{
  "data": [
    {
      "active": true,
      "anchorsite_override": "Latency",
      "connection_name": "string",
      "created_at": "2018-02-02T22:25:27.521Z",
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "outbound_voice_profile_id": "1293384261075731499",
      "record_type": "ip_connection",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "webhook_api_version": "1",
      "webhook_event_failover_url": "https://failover.example.com",
      "webhook_event_url": "https://example.com"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}