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

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": "44957076-778a-4802-b60c-d22db0cda284",
    "type": "dids",
    "attributes": {
      "blocked": false,
      "capacity_limit": 1,
      "description": "string",
      "terminated": false,
      "awaiting_registration": false,
      "number": "437xxxxxxxxx",
      "expires_at": "2017-06-25T08:21:41.795Z",
      "channels_included_count": 2,
      "created_at": "2017-06-25T08:21:41.795Z",
      "pending_removal": false,
      "dedicated_channels_count": 0,
      "emergency_enabled": false
    },
    "relationships": {
      "did_group": {
        "links": {
          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/did_group",
          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/did_group"
        }
      },
      "order": {
        "links": {
          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/order",
          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/order"
        }
      },
      "voice_in_trunk": {
        "links": {
          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk",
          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk"
        }
      },
      "voice_in_trunk_group": {
        "links": {
          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk_group",
          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk_group"
        }
      },
      "capacity_pool": {
        "links": {
          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/capacity_pool",
          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/capacity_pool"
        }
      },
      "shared_capacity_group": {
        "links": {
          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/shared_capacity_group",
          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/shared_capacity_group"
        }
      },
      "address_verification": {
        "links": {
          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/address_verification",
          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/address_verification"
        }
      },
      "emergency_calling_service": {
        "links": {
          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_calling_service",
          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_calling_service"
        }
      },
      "emergency_verification": {
        "links": {
          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_verification",
          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_verification"
        }
      },
      "identity": {
        "links": {
          "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/identity",
          "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/identity"
        }
      }
    }
  },
  "meta": {
    "api_version": "2026-04-16"
  }
}

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized