Get DID Reservation

Returns a single DID Reservation.

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

Simple RequestRequest with available_did include

http

GET /v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa 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/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa -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": "09c3c91b-f7bf-4db3-b94a-63824b8b1bfa",
        "type": "did_reservations",
        "attributes": {
            "expires_at": "2022-06-27T10:52:16.564Z",
            "created_at": "2022-06-27T10:42:16.577Z",
            "description": "DIDWW"
        },
        "relationships": {
            "available_did": {
                "links": {
                    "self": "https://api.didww.com/v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa/relationships/available_did",
                    "related": "https://api.didww.com/v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa/available_did"
                }
            }
        }
    },
    "meta": {
        "available_count": 9,
        "api_version": "2026-04-16"
    }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized