# 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](did-reservation-object.html).

### URI Query Parameters

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| id | `string` | Yes | Unique ID number of the DID Reservation. |
| include | `string` | No | [Inclusion](../../../specification/includes.html#api-includes) |

### Includes

| Value | Description |
| --- | --- |
| available\_did | [Available DID Object](../available-did/available-did-object.html#available-did-object-v35) |
| available\_did.did\_group | [DID Group Object](../did-group/did-group-object.html#did-group-object-v35) |
| available\_did.did\_group.stock\_keeping\_units | [Stock Keeping Unit Object](../../common-definitions/index.html#stock-keeping-unit-object-v35) |

## Examples

Simple RequestRequest with available\_did include

[[DIDWW-API-EXAMPLE-START]]

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

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa?include=available_did 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?include=available_did' -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                "data": {
20                    "type": "available_dids",
21                    "id": "44ba95af-4b61-49a8-ae41-6235cc8cb573"
22                }
23            }
24        }
25    },
26    "included": [
27        {
28            "id": "44ba95af-4b61-49a8-ae41-6235cc8cb573",
29            "type": "available_dids",
30            "attributes": {
31                "number": "12124727602"
32            },
33            "relationships": {
34                "did_group": {
35                    "links": {
36                        "self": "https://api.didww.com/v3/available_dids/44ba95af-4b61-49a8-ae41-6235cc8cb573/relationships/did_group",
37                        "related": "https://api.didww.com/v3/available_dids/44ba95af-4b61-49a8-ae41-6235cc8cb573/did_group"
38                    }
39                },
40                "nanpa_prefix": {
41                    "links": {
42                        "self": "https://api.didww.com/v3/available_dids/44ba95af-4b61-49a8-ae41-6235cc8cb573/relationships/nanpa_prefix",
43                        "related": "https://api.didww.com/v3/available_dids/44ba95af-4b61-49a8-ae41-6235cc8cb573/nanpa_prefix"
44                    }
45                }
46            }
47        }
48    ],
49    "meta": {
50        "available_count": 9,
51        "api_version": "2026-11-19"
52    }
53}
```

[[DIDWW-API-EXAMPLE-END]]

## 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](../../../specification/errors/index.html#api-not-found) |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35) |
| 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. |
