Skip to main content

List connections

GET 
/connections

Returns a list of your connections irrespective of type.

Request

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 250

    The size of the page

    filter[connection_name][contains] string

    If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

    filter[outbound_voice_profile_id] int64

    Identifies the associated outbound voice profile.

    sort string

    Possible values: [created_at, connection_name, active]

    Default value: created_at

    Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

    That is:

    • connection_name: sorts the result by the connection_name field in ascending order.
    • -connection_name: sorts the result by the connection_name field in descending order.

    If not given, results are sorted by
    created_at
    in descending order.

Responses

200: Successful response with a list of connections.

400: Bad request, the request was unacceptable, often due to missing a required parameter.

401: Unauthorized

403: The user doesn't have the required permissions to perform the requested action.

Request samples


curl -L 'https://api.telnyx.com/v2/connections' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples


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