# 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](did-reservation-object.html). ### URI Query Parameters | Name | Type | Is Required? | Description | | --- | --- | --- | --- | | include | `string` | No | [Inclusion](../../../specification/includes.html#api-includes) | | filter[] | `string` | No | [Filtering](../../../specification/filtering.html#api-filters) | | fields[did\_reservations] | `string` | No | [Sparse fieldsets](../../../specification/sparse-fieldsets.html#api-sparse-fieldsets) | | sort | `string` | No | [Sorting](../../../specification/sorting.html#api-sorting) | ### Includes | Value | Description | | --- | --- | | available\_did | [Available DID Object](../available-did/available-did-object.html#available-did-object-v34) | | available\_did.did\_group | [DID Group Object](../did-group/did-group-object.html#did-group-object-v34) | | available\_did.did\_group.stock\_keeping\_units | [Stock Keeping Unit Object](../../common-definitions/index.html#stock-keeping-unit-object-v34) | ### Filters | Filter Name | Type | Allow Blank | Allow Array | Filters by: | | --- | --- | --- | --- | --- | | id | `string` | No | Yes | DID Reservation `id` field. | ## Examples Simple RequestRequest with available\_did include [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/did_reservations 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 -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" } } } }, { "id": "e85a5b1f-850d-498f-8418-ec74cccc9e9a", "type": "did_reservations", "attributes": { "expires_at": "2022-06-27T10:59:58.131Z", "created_at": "2022-06-27T10:49:58.151Z", "description": "DIDWW" }, "relationships": { "available_did": { "links": { "self": "https://api.didww.com/v3/did_reservations/e85a5b1f-850d-498f-8418-ec74cccc9e9a/relationships/available_did", "related": "https://api.didww.com/v3/did_reservations/e85a5b1f-850d-498f-8418-ec74cccc9e9a/available_did" } } } }, { "id": "4789767d-d59a-485b-9adb-da14b4859f51", "type": "did_reservations", "attributes": { "expires_at": "2022-06-27T11:00:03.332Z", "created_at": "2022-06-27T10:50:03.344Z", "description": "DIDWW" }, "relationships": { "available_did": { "links": { "self": "https://api.didww.com/v3/did_reservations/4789767d-d59a-485b-9adb-da14b4859f51/relationships/available_did", "related": "https://api.didww.com/v3/did_reservations/4789767d-d59a-485b-9adb-da14b4859f51/available_did" } } } } ], "meta": { "total_records": 3, "available_count": 7, "api_version": "2026-04-16" }, "links": { "first": "https://api.didww.com/v3/did_reservations?page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://api.didww.com/v3/did_reservations?page%5Bnumber%5D=1&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/did_reservations?include=available_did 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://nohost/v3/did_reservations?include=available_did' ``` 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" }, "data": { "type": "available_dids", "id": "44ba95af-4b61-49a8-ae41-6235cc8cb573" } } } }, { "id": "e85a5b1f-850d-498f-8418-ec74cccc9e9a", "type": "did_reservations", "attributes": { "expires_at": "2022-06-27T10:59:58.131Z", "created_at": "2022-06-27T10:49:58.151Z", "description": "DIDWW" }, "relationships": { "available_did": { "links": { "self": "https://api.didww.com/v3/did_reservations/e85a5b1f-850d-498f-8418-ec74cccc9e9a/relationships/available_did", "related": "https://api.didww.com/v3/did_reservations/e85a5b1f-850d-498f-8418-ec74cccc9e9a/available_did" }, "data": { "type": "available_dids", "id": "8559343c-ebd1-4fbf-8dc6-d6cd30ca8c3f" } } } }, { "id": "4789767d-d59a-485b-9adb-da14b4859f51", "type": "did_reservations", "attributes": { "expires_at": "2022-06-27T11:00:03.332Z", "created_at": "2022-06-27T10:50:03.344Z", "description": "DIDWW" }, "relationships": { "available_did": { "links": { "self": "https://api.didww.com/v3/did_reservations/4789767d-d59a-485b-9adb-da14b4859f51/relationships/available_did", "related": "https://api.didww.com/v3/did_reservations/4789767d-d59a-485b-9adb-da14b4859f51/available_did" }, "data": { "type": "available_dids", "id": "7f396769-5203-470c-9595-b158c6bba7c8" } } } } ], "included": [ { "id": "44ba95af-4b61-49a8-ae41-6235cc8cb573", "type": "available_dids", "attributes": { "number": "12124727602" }, "relationships": { "did_group": { "links": { "self": "https://api.didww.com/v3/available_dids/44ba95af-4b61-49a8-ae41-6235cc8cb573/relationships/did_group", "related": "https://api.didww.com/v3/available_dids/44ba95af-4b61-49a8-ae41-6235cc8cb573/did_group" } }, "nanpa_prefix": { "links": { "self": "https://api.didww.com/v3/available_dids/44ba95af-4b61-49a8-ae41-6235cc8cb573/relationships/nanpa_prefix", "related": "https://api.didww.com/v3/available_dids/44ba95af-4b61-49a8-ae41-6235cc8cb573/nanpa_prefix" } } } }, { "id": "8559343c-ebd1-4fbf-8dc6-d6cd30ca8c3f", "type": "available_dids", "attributes": { "number": "526316907325" }, "relationships": { "did_group": { "links": { "self": "https://api.didww.com/v3/available_dids/8559343c-ebd1-4fbf-8dc6-d6cd30ca8c3f/relationships/did_group", "related": "https://api.didww.com/v3/available_dids/8559343c-ebd1-4fbf-8dc6-d6cd30ca8c3f/did_group" } }, "nanpa_prefix": { "links": { "self": "https://api.didww.com/v3/available_dids/8559343c-ebd1-4fbf-8dc6-d6cd30ca8c3f/relationships/nanpa_prefix", "related": "https://api.didww.com/v3/available_dids/8559343c-ebd1-4fbf-8dc6-d6cd30ca8c3f/nanpa_prefix" } } } }, { "id": "7f396769-5203-470c-9595-b158c6bba7c8", "type": "available_dids", "attributes": { "number": "12124727603" }, "relationships": { "did_group": { "links": { "self": "https://api.didww.com/v3/available_dids/7f396769-5203-470c-9595-b158c6bba7c8/relationships/did_group", "related": "https://api.didww.com/v3/available_dids/7f396769-5203-470c-9595-b158c6bba7c8/did_group" } }, "nanpa_prefix": { "links": { "self": "https://api.didww.com/v3/available_dids/7f396769-5203-470c-9595-b158c6bba7c8/relationships/nanpa_prefix", "related": "https://api.didww.com/v3/available_dids/7f396769-5203-470c-9595-b158c6bba7c8/nanpa_prefix" } } } } ], "meta": { "total_records": 3, "available_count": 7, "api_version": "2026-04-16" }, "links": { "first": "https://api.didww.com/v3/did_reservations?include=available_did&page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://api.didww.com/v3/did_reservations?include=available_did&page%5Bnumber%5D=1&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] ## Other Responses | Code | Success | Description | | --- | --- | --- | | 401 | No | [Unauthorized](../../../configuration.html#api-key) | On this page