Get Trunk Groups

GET https://{{host}}/v3/trunk_groups

Returns a collection of Trunk Groups.

Request Params

Key	Datatype	Description
`include`	null	Comma-separated values of include parameter.
The response will include a top-level object `relationships` with associated data under the appropriate resource key.
Details in Inclusion of Related Resources Article.

Allowed values:

trunks - List of Trunk Objects *** | | sort | null | | Used for sorting the fields returned by the request, with a comma , separating the included fields. Details in Sorting Article.

name - The name field.

created_at - The created_at field.

capacity_limit - The capacity_limit field. *** |

HEADERS

Key	Datatype	Required	Description
`Accept`	string
`Content-Type`	string
`Api-Key`	string

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;id&quot;:&quot;a8176983-61c4-4768-b699-10d5f3245d90&quot;,&quot;type&quot;:&quot;trunk_groups&quot;,&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/trunk_groups/a8176983-61c4-4768-b699-10d5f3245d90&quot;},&quot;attributes&quot;:{&quot;created_at&quot;:&quot;2017-06-25T14:56:31.513Z&quot;,&quot;name&quot;:&quot;Common Group&quot;,&quot;capacity_limit&quot;:69},&quot;relationships&quot;:{&quot;trunks&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/trunk_groups/a8176983-61c4-4768-b699-10d5f3245d90/relationships/trunks&quot;,&quot;related&quot;:&quot;https://api.didww.com/v3/trunk_groups/a8176983-61c4-4768-b699-10d5f3245d90/trunks&quot;},&quot;data&quot;:[{&quot;type&quot;:&quot;trunks&quot;,&quot;id&quot;:&quot;5aa0b0ea-2bda-4424-a93c-104829d72c06&quot;}]}},&quot;meta&quot;:{&quot;trunks_count&quot;:1}},{&quot;id&quot;:&quot;def3b7b1-ce76-420d-9684-8dbdb69e17c1&quot;,&quot;type&quot;:&quot;trunk_groups&quot;,&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/trunk_groups/def3b7b1-ce76-420d-9684-8dbdb69e17c1&quot;},&quot;attributes&quot;:{&quot;created_at&quot;:&quot;2017-06-25T14:56:31.513Z&quot;,&quot;name&quot;:&quot;Custom Group&quot;,&quot;capacity_limit&quot;:50},&quot;relationships&quot;:{&quot;trunks&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/trunk_groups/def3b7b1-ce76-420d-9684-8dbdb69e17c1/relationships/trunks&quot;,&quot;related&quot;:&quot;https://api.didww.com/v3/trunk_groups/def3b7b1-ce76-420d-9684-8dbdb69e17c1/trunks&quot;},&quot;data&quot;:[]}},&quot;meta&quot;:{&quot;trunks_count&quot;:0}}],&quot;included&quot;:[{&quot;id&quot;:&quot;5aa0b0ea-2bda-4424-a93c-104829d72c06&quot;,&quot;type&quot;:&quot;trunks&quot;,&quot;attributes&quot;:{&quot;priority&quot;:1,&quot;capacity_limit&quot;:5,&quot;weight&quot;:65535,&quot;name&quot;:&quot;Office Mobile&quot;,&quot;cli_format&quot;:&quot;e164&quot;,&quot;cli_prefix&quot;:null,&quot;description&quot;:null,&quot;ringing_timeout&quot;:null,&quot;configuration&quot;:{&quot;type&quot;:&quot;pstn_configurations&quot;,&quot;attributes&quot;:{&quot;dst&quot;:&quot;1xxxxxxxxx&quot;}}},&quot;relationships&quot;:{&quot;trunk_group&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/trunks/5aa0b0ea-2bda-4424-a93c-104829d72c06/relationships/trunk_group&quot;,&quot;related&quot;:&quot;https://api.didww.com/v3/trunks/5aa0b0ea-2bda-4424-a93c-104829d72c06/trunk_group&quot;}}}}],&quot;meta&quot;:{&quot;total_records&quot;:2,&quot;api_version&quot;:&quot;2021-04-19&quot;},&quot;links&quot;:{&quot;first&quot;:&quot;https://api.didww.com/v3/trunk_groups?include=trunks\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50&quot;,&quot;last&quot;:&quot;https://api.didww.com/v3/trunk_groups?include=trunks\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50&quot;}}