Get DID

Returns a single DID owned by your account.

Request

HTTP Method: GET

URI Path: /v3/dids/

URI Query Parameters

Name	Type	Is Required?	Description
id	string	Yes	Unique ID identifier of the Order.
include	string	No	Related resources to include in the response. See Inclusion.

Includes

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

Simple RequestRequest with did_group Include

http

GET /v3/dids/44957076-778a-4802-b60c-d22db0cda284 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/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

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

{
    "data": {
        "id": "9c55ccc7-8b8e-4684-beaa-9f81462dcfdb",
        "type": "dids",
        "attributes": {
            "blocked": false,
            "capacity_limit": 1,
            "description": "description",
            "terminated": false,
            "awaiting_registration": false,
            "created_at": "2020-09-14T07:35:07.198Z",
            "billing_cycles_count": null,
            "number": "35314403952",
            "expires_at": "2021-05-14T07:36:06.443Z",
            "channels_included_count": 0,
            "dedicated_channels_count": 0
        },
        "relationships": {
            "did_group": {
                "links": {
                    "self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/did_group",
                    "related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/did_group"
                }
            },
            "order": {
                "links": {
                    "self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/order",
                    "related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/order"
                }
            },
            "voice_in_trunk": {
                "links": {
                    "self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/voice_in_trunk",
                    "related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/voice_in_trunk"
                }
            },
            "voice_in_trunk_group": {
                "links": {
                    "self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/voice_in_trunk_group",
                    "related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/voice_in_trunk_group"
                }
            },
            "capacity_pool": {
                "links": {
                    "self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/capacity_pool",
                    "related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/capacity_pool"
                }
            },
            "shared_capacity_group": {
                "links": {
                    "self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/shared_capacity_group",
                    "related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/shared_capacity_group"
                }
            },
            "address_verification": {
                "links": {
                    "self": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/relationships/address_verification",
                    "related": "https://api.didww.com/v3/dids/9c55ccc7-8b8e-4684-beaa-9f81462dcfdb/address_verification"
                }
            }
        }
    },
    "meta": {
        "api_version": "2022-05-10"
    }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized