Get DID#

Returns a single DID owned by your account.

Request#

HTTP Method: GET

URI Path: /v3/dids/{id}

Note

For all returned data attributes, see Did Object.

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of the DID.

include

string

No

Related resources to include in the response. See Inclusion.

Includes#

Value

Description

order

Order Object

voice_in_trunk

Trunk Object

voice_in_trunk.voice_in_trunk_group

Trunk Group Object

voice_in_trunk.pop

POP Object

voice_in_trunk_group

Trunk Group Object

capacity_pool

Capacity Pool Object

shared_capacity_group

Shared Capacity Group Object

did_group

DID Group Object

identity

Identity Object

emergency_calling_service

Emergency Calling Service Object

emergency_verification

Emergency Verification Object

did_group.country

Country Object

did_group.city

City Object

did_group.region

Region Object

did_group.did_group_type

DID Group Type Object

did_group.stock_keeping_units

Stock Keeping Unit Object

Object Relationships#

Value

Description

order

Order Object

voice_in_trunk

Trunk Object

voice_in_trunk.voice_in_trunk_group

Trunk Group Object

voice_in_trunk.pop

POP Object

voice_in_trunk_group

Trunk Group Object

capacity_pool

Capacity Pool Object

shared_capacity_group

Shared Capacity Group Object

did_group

DID Group Object

identity

Identity Object

emergency_calling_service

Emergency Calling Service resource

emergency_verification

Emergency Verification resource

did_group.country

Country Object

did_group.city

City Object

did_group.region

Region Object

did_group.did_group_type

DID Group Type Object

did_group.stock_keeping_units

Stock Keeping Unit Object

Examples#

http

1GET /v3/dids/44957076-778a-4802-b60c-d22db0cda284 HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]

curl

1curl -i -X GET https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284 -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "44957076-778a-4802-b60c-d22db0cda284",
 7    "type": "dids",
 8    "attributes": {
 9      "blocked": false,
10      "capacity_limit": 1,
11      "description": "string",
12      "terminated": false,
13      "awaiting_registration": false,
14      "number": "437xxxxxxxxx",
15      "expires_at": "2017-06-25T08:21:41.795Z",
16      "channels_included_count": 2,
17      "created_at": "2017-06-25T08:21:41.795Z",
18      "dedicated_channels_count": 0,
19      "emergency_enabled": false
20    },
21    "relationships": {
22      "did_group": {
23        "links": {
24          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/did_group",
25          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/did_group"
26        }
27      },
28      "order": {
29        "links": {
30          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/order",
31          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/order"
32        }
33      },
34      "voice_in_trunk": {
35        "links": {
36          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk",
37          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk"
38        }
39      },
40      "voice_in_trunk_group": {
41        "links": {
42          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk_group",
43          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk_group"
44        }
45      },
46      "capacity_pool": {
47        "links": {
48          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/capacity_pool",
49          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/capacity_pool"
50        }
51      },
52      "shared_capacity_group": {
53        "links": {
54          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/shared_capacity_group",
55          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/shared_capacity_group"
56        }
57      },
58      "address_verification": {
59        "links": {
60          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/address_verification",
61          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/address_verification"
62        }
63      },
64      "emergency_calling_service": {
65        "links": {
66          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_calling_service",
67          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_calling_service"
68        }
69      },
70      "emergency_verification": {
71        "links": {
72          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_verification",
73          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_verification"
74        }
75      },
76      "identity": {
77        "links": {
78          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/identity",
79          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/identity"
80        }
81      }
82    }
83  },
84  "meta": {
85    "api_version": "2026-04-16"
86  }
87}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized