Get SMS Trunk Groups#

Returns the collection of SMS trunk groups configured for the account.

Request#

HTTP Method: GET

URI Path: /v3/sms_trunk_groups

Note

For all returned data attributes, see SMS Trunk Group Object.

URI Query Parameters#

Name

Type

Is Required?

Description

include

string

No

Inclusion

filter[<filter_name>]

string

No

Filtering

fields[sms_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

sms_trunks

SMS Trunk Object. The trunks in the group.

incoming_dids

DID Object. DIDs routed to the group for inbound messages.

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

The group id field.

name

string

No

Yes

The group name field (exact match).

external_reference_id

string

No

No

The external_reference_id field.

Sorting#

Value

Sorts by:

name

The name field.

external_reference_id

The external_reference_id field.

created_at

The created_at field.

updated_at

The updated_at field.

Prefix a value with - to sort in descending order.

Examples#

http

1GET /v3/sms_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/sms_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": "c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46",
 8      "type": "sms_trunk_groups",
 9      "attributes": {
10        "name": "Inbound SMS",
11        "external_reference_id": null,
12        "created_at": "2026-10-22T09:15:42.118Z",
13        "updated_at": "2026-10-22T09:15:42.118Z"
14      },
15      "relationships": {
16        "sms_trunks": {
17          "links": {
18            "self": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/relationships/sms_trunks",
19            "related": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/sms_trunks"
20          }
21        },
22        "incoming_dids": {
23          "links": {
24            "self": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/relationships/incoming_dids",
25            "related": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/incoming_dids"
26          }
27        }
28      },
29      "meta": {
30        "sms_trunks_count": 2
31      }
32    },
33    {
34      "id": "d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91",
35      "type": "sms_trunk_groups",
36      "attributes": {
37        "name": "Support SMS",
38        "external_reference_id": "crm-7781",
39        "created_at": "2026-10-22T09:15:42.118Z",
40        "updated_at": "2026-10-22T09:15:42.118Z"
41      },
42      "relationships": {
43        "sms_trunks": {
44          "links": {
45            "self": "https://api.didww.com/v3/sms_trunk_groups/d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91/relationships/sms_trunks",
46            "related": "https://api.didww.com/v3/sms_trunk_groups/d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91/sms_trunks"
47          }
48        },
49        "incoming_dids": {
50          "links": {
51            "self": "https://api.didww.com/v3/sms_trunk_groups/d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91/relationships/incoming_dids",
52            "related": "https://api.didww.com/v3/sms_trunk_groups/d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91/incoming_dids"
53          }
54        }
55      },
56      "meta": {
57        "sms_trunks_count": 0
58      }
59    }
60  ],
61  "meta": {
62    "api_version": "2026-11-19",
63    "total_records": 2
64  },
65  "links": {
66    "first": "https://api.didww.com/v3/sms_trunk_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
67    "last": "https://api.didww.com/v3/sms_trunk_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
68  }
69}

Other Responses#

Code

Success

Description

400

No

Bad Request

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.