Get DID Reservations#

Returns a list of DID Reservations.

Request#

HTTP Method: GET

URI Path: /v3/did_reservations

Note

For all returned data attributes, see Did Reservation Object.

URI Query Parameters#

Name

Type

Is Required?

Description

include

string

No

Inclusion

filter[<filter_name>]

string

No

Filtering

fields[did_reservations]

string

No

Sparse fieldsets

sort

string

No

Sorting

page[number]

integer

No

Page number.

page[size]

integer

No

Page size. Pagination defaults to 50 records per page. The maximum is 100.

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

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

DID Reservation id field.

description

string

Yes

No

DID Reservations whose description field contains this value.

Sorting#

Value

Sorts by:

created_at

The created_at field.

description

The description field.

expires_at

The expires_at field.

Prefix a value with - to sort in descending order.

Examples#

http

1GET /v3/did_reservations 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 -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        {
 7            "id": "09c3c91b-f7bf-4db3-b94a-63824b8b1bfa",
 8            "type": "did_reservations",
 9            "attributes": {
10                "expires_at": "2022-06-27T10:52:16.564Z",
11                "created_at": "2022-06-27T10:42:16.577Z",
12                "description": "DIDWW"
13            },
14            "relationships": {
15                "available_did": {
16                    "links": {
17                        "self": "https://api.didww.com/v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa/relationships/available_did",
18                        "related": "https://api.didww.com/v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa/available_did"
19                    }
20                }
21            }
22        },
23        {
24            "id": "e85a5b1f-850d-498f-8418-ec74cccc9e9a",
25            "type": "did_reservations",
26            "attributes": {
27                "expires_at": "2022-06-27T10:59:58.131Z",
28                "created_at": "2022-06-27T10:49:58.151Z",
29                "description": "DIDWW"
30            },
31            "relationships": {
32                "available_did": {
33                    "links": {
34                        "self": "https://api.didww.com/v3/did_reservations/e85a5b1f-850d-498f-8418-ec74cccc9e9a/relationships/available_did",
35                        "related": "https://api.didww.com/v3/did_reservations/e85a5b1f-850d-498f-8418-ec74cccc9e9a/available_did"
36                    }
37                }
38            }
39        },
40        {
41            "id": "4789767d-d59a-485b-9adb-da14b4859f51",
42            "type": "did_reservations",
43            "attributes": {
44                "expires_at": "2022-06-27T11:00:03.332Z",
45                "created_at": "2022-06-27T10:50:03.344Z",
46                "description": "DIDWW"
47            },
48            "relationships": {
49                "available_did": {
50                    "links": {
51                        "self": "https://api.didww.com/v3/did_reservations/4789767d-d59a-485b-9adb-da14b4859f51/relationships/available_did",
52                        "related": "https://api.didww.com/v3/did_reservations/4789767d-d59a-485b-9adb-da14b4859f51/available_did"
53                    }
54                }
55            }
56        }
57    ],
58    "meta": {
59        "total_records": 3,
60        "available_count": 7,
61        "api_version": "2026-11-19"
62    },
63    "links": {
64        "first": "https://api.didww.com/v3/did_reservations?page%5Bnumber%5D=1&page%5Bsize%5D=50",
65        "last": "https://api.didww.com/v3/did_reservations?page%5Bnumber%5D=1&page%5Bsize%5D=50"
66    }
67}

Top Level Meta Attributes#

Name

Type

Description

available_count

integer

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

total_records

integer

Total number of reservations that match the query.

api_version

string

API version that served the request.

Other Responses#

Code

Success

Description

400

No

Bad Request

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.