Get Trunk Group

Description

Returns a single Trunk Group.

Request

HTTP Method: GET

URI Path: /v3/trunk_groups/

URI Query Parameters:

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of the Trunk Group.

include

string

Optional

Inclusion.

Includes:

Value

Description

trunks

List of Trunk Objects

Examples

http

GET /v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -i -X GET https://api.didww.com/v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664 -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "418fe352-04b8-4e03-a7ce-cb57efd8c664",
    "type": "trunk_groups",
    "links": {
      "self": "https://api.didww.com/v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664"
    },
    "attributes": {
      "created_at": "2017-06-25T14:56:31.513Z",
      "name": "Common Group",
      "capacity_limit": 69
    },
    "relationships": {
      "trunks": {
        "links": {
          "self": "https://api.didww.com/v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664/relationships/trunks",
          "related": "https://api.didww.com/v3/trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664/trunks"
        }
      }
    },
    "meta": {
      "trunks_count": 1
    }
  }
}

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized