Get DID Reservation#

Returns a single DID Reservation.

Request#

HTTP Method: GET

URI Path: /v3/did_reservations/{id}

Note

For all returned data attributes, see Did Reservation Object.

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID number of the DID Reservation.

include

string

No

Inclusion

Includes#

Value

Description

available_did

Available DID Object

available_did.did_group

DID Group Object

available_did.did_group.stock_keeping_units

Stock Keeping Unit Object

Examples#

http

1GET /v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa 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/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa -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": "09c3c91b-f7bf-4db3-b94a-63824b8b1bfa",
 7        "type": "did_reservations",
 8        "attributes": {
 9            "expires_at": "2022-06-27T10:52:16.564Z",
10            "created_at": "2022-06-27T10:42:16.577Z",
11            "description": "DIDWW"
12        },
13        "relationships": {
14            "available_did": {
15                "links": {
16                    "self": "https://api.didww.com/v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa/relationships/available_did",
17                    "related": "https://api.didww.com/v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa/available_did"
18                }
19            }
20        }
21    },
22    "meta": {
23        "available_count": 9,
24        "api_version": "2026-11-19"
25    }
26}

Top Level Meta Attributes#

Name

Type

Description

available_count

integer

Number of further DIDs the account can reserve under its numbers selection plan.

api_version

string

API version that served the request.

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized

403

No

Numbers selection is not enabled for the account.

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.