Get DID reservations
GET https://{{host}}/v3/did_reservations
Returns a list of DID Reservations.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | null | Comma-separated values of include parameter. | |
The response will include a top-level object relationships with associated data under the appropriate resource key. | |||
| Details in Inclusion of Related Resources Article. |
Allowed values:
available_did - Available DID Object
available_did.did_group - DID Group Object
available_did.did_group.stock_keeping_units - Stock Keeping Unit Object
*** |
| filter[id] | null | | string - Filters by DID reservation id field.
- Allow blank - No.
- Allow array - Yes. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: OK
{"data":[{"id":"d0163fe0-001f-4a03-87ea-84224822708e","type":"did_reservations","attributes":{"expire_at":"2018-03-15 12:34:56","created_at":"2018-03-15 12:14:56","description":"DIDWW"},"relationships":{"available_did":{"links":{"self":"https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/relationships/available_did","related":"https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/available_did"},"data":{"type":"available_dids","id":"8bc37f63-acd7-4e43-a760-1a1caa6e4683"}}}},{"id":"952b0724-45bc-4f87-b31b-ff04579357ef","type":"did_reservations","attributes":{"expire_at":"2018-03-15 12:34:56","created_at":"2018-03-15 12:14:56","description":"DIDWW"},"relationships":{"available_did":{"links":{"self":"https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/relationships/available_did","related":"https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/available_did"},"data":{"type":"available_dids","id":"8bc37f63-acd7-4e43-a760-1a1caa6e4683"}}}}],"included":[{"id":"8bc37f63-acd7-4e43-a760-1a1caa6e4683","type":"available_dids","attributes":{"number":"77124562356"}}],"meta":{"total_records":2,"available_count":8,"api_version":"2022-05-10"},"links":{"first":"https://api.didww.com/v3/did_reservations?include=available_did\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50","last":"https://api.didww.com/v3/did_reservations?include=available_did\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50"}}