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.

fields[dids]

string

No

Sparse fieldsets

Includes#

Value

Description

order

Order Object

voice_in_trunk

Trunk Object

voice_in_trunk.voice_in_trunk_group

Trunk Group Object

voice_in_trunk_group

Trunk Group Object

sms_trunk

SMS Trunk Object

sms_trunk_group

SMS 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

address_verification

Address Verifications Object

did_group.country

Country Object

did_group.city

City Object

did_group.region

Region 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_group

Trunk Group Object

sms_trunk

SMS Trunk Object

sms_trunk_group

SMS 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.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
5Authorization: Bearer [access token]

curl

1curl -i -X GET https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284 -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    "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      "billing_cycles_count": null,
 20      "emergency_enabled": false
 21    },
 22    "relationships": {
 23      "did_group": {
 24        "links": {
 25          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/did_group",
 26          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/did_group"
 27        }
 28      },
 29      "order": {
 30        "links": {
 31          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/order",
 32          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/order"
 33        }
 34      },
 35      "voice_in_trunk": {
 36        "links": {
 37          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk",
 38          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk"
 39        }
 40      },
 41      "voice_in_trunk_group": {
 42        "links": {
 43          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk_group",
 44          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk_group"
 45        }
 46      },
 47      "capacity_pool": {
 48        "links": {
 49          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/capacity_pool",
 50          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/capacity_pool"
 51        }
 52      },
 53      "shared_capacity_group": {
 54        "links": {
 55          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/shared_capacity_group",
 56          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/shared_capacity_group"
 57        }
 58      },
 59      "sms_trunk": {
 60        "links": {
 61          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/sms_trunk",
 62          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/sms_trunk"
 63        }
 64      },
 65      "sms_trunk_group": {
 66        "links": {
 67          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/sms_trunk_group",
 68          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/sms_trunk_group"
 69        }
 70      },
 71      "address_verification": {
 72        "links": {
 73          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/address_verification",
 74          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/address_verification"
 75        }
 76      },
 77      "emergency_calling_service": {
 78        "links": {
 79          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_calling_service",
 80          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_calling_service"
 81        }
 82      },
 83      "emergency_verification": {
 84        "links": {
 85          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_verification",
 86          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_verification"
 87        }
 88      },
 89      "identity": {
 90        "links": {
 91          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/identity",
 92          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/identity"
 93        }
 94      }
 95    }
 96  },
 97  "meta": {
 98    "api_version": "2026-11-19"
 99  }
100}

Other Responses#

Code

Success

Description

404

No

Not Found

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.