Get Inbound Trunk Groups#

Returns a collection of Trunk Groups.

Request#

HTTP Method: GET

URI Path: /v3/voice_in_trunk_groups

Note

For all returned data attributes, see Trunk Group Object.

URI Query Parameters#

Name

Type

Is Required?

Description

include

string

No

Inclusion

filter[<filter_name>]

string

No

Filtering

fields[voice_in_trunk_groups]

string

No

Sparse fieldsets

sort

string

No

Sorting

page[number]

integer

No

Page number.

page[size]

integer

No

Page size. Pagination defaults to 50 records per page. The maximum is 100.

Includes#

Value

Description

voice_in_trunks

Trunk Object

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

The trunk group id field.

external_reference_id

string

No

No

The external_reference_id field.

Sorting#

Value

Sorts by:

name

The name field.

created_at

The created_at field.

external_reference_id

The external_reference_id field.

capacity_limit

The capacity_limit field.

Examples#

http

1GET /v3/voice_in_trunk_groups HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]

curl

1curl -i -X GET https://api.didww.com/v3/voice_in_trunk_groups -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": [
 6    {
 7      "id": "65b401cb-42f5-4911-877d-dc317a46b478",
 8      "type": "voice_in_trunk_groups",
 9      "attributes": {
10        "created_at": "2017-06-25T14:56:31.513Z",
11        "external_reference_id": null,
12        "name": "Common Group",
13        "capacity_limit": 69
14      },
15      "relationships": {
16        "voice_in_trunks": {
17          "links": {
18            "self": "https://api.didww.com/v3/voice_in_trunk_groups/65b401cb-42f5-4911-877d-dc317a46b478/relationships/voice_in_trunks",
19            "related": "https://api.didww.com/v3/voice_in_trunk_groups/65b401cb-42f5-4911-877d-dc317a46b478/voice_in_trunks"
20          }
21        }
22      },
23      "meta": {
24        "trunks_count": 1
25      }
26    },
27    {
28      "id": "72a60b4a-affb-46c7-8a8a-7e042c7611e8",
29      "type": "voice_in_trunk_groups",
30      "attributes": {
31        "created_at": "2017-06-25T14:56:31.513Z",
32        "external_reference_id": null,
33        "name": "Custom Group",
34        "capacity_limit": 50
35      },
36      "relationships": {
37        "voice_in_trunks": {
38          "links": {
39            "self": "https://api.didww.com/v3/voice_in_trunk_groups/72a60b4a-affb-46c7-8a8a-7e042c7611e8/relationships/voice_in_trunks",
40            "related": "https://api.didww.com/v3/voice_in_trunk_groups/72a60b4a-affb-46c7-8a8a-7e042c7611e8/voice_in_trunks"
41          }
42        }
43      },
44      "meta": {
45        "trunks_count": 0
46      }
47    }
48  ],
49  "meta": {
50    "total_records": 2,
51    "api_version": "2026-11-19"
52  },
53  "links": {
54    "first": "https://api.didww.com/v3/voice_in_trunk_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
55    "last": "https://api.didww.com/v3/voice_in_trunk_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
56  }
57}

Other Responses#

Code

Success

Description

400

No

Bad Request. Malformed request: unknown filter, bad pagination or bad sort field.

401

No

Unauthorized

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.