StoreBay Developers
Commerce

Retrieve a reservation

GET
/reservations/{id}

Authorization

AuthorizationBearer <token>

Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.

In: header

Path Parameters

id*string

UUIDv7 identifier of the resource.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/reservations/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "object": "reservation",    "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",    "unit_id": "5becc822-b69e-4e66-a762-ad8e868dcab6",    "unit_type_id": "09feeea8-7692-422e-90f1-4a851084cb1a",    "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",    "status": "held",    "source": "string",    "quoted_price_minor": 0,    "currency": "str",    "move_in_date": "2019-08-24",    "held_until": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid credential."  }}
{  "error": {    "code": "insufficient_scope",    "message": "The credential lacks a scope required by this endpoint."  }}
{  "error": {    "code": "not_found",    "message": "Resource not found."  }}
{  "error": {    "code": "validation_error",    "message": "string",    "details": [      {        "field": "string",        "issue": "string"      }    ]  }}