Get a Reservation

Get reservation details using Goki ID

Get a Reservation by ID

GET [environmentBaseUrl]/v1/reservations/:id

This is useful if you want to get a reservation using Goki's reservation ID. In case you want to find a reservation using your pmsId you need to use Find a Reservation API.

Path Parameters

Name	Type	Description
id	string	ID of the reservation in Goki.

Query Parameters

Name	Type	Description
extend	String	Reservation extend option. The options are "pin", "gatePins", and "space". By setting any option as extend you will have it in response. You can pass multi options comma separated.

200 Reservation successfully retrieved.

{
  "data": {
    ...ReservationDocument, // Check ReservationDocument page for the sample data
    "pin": "8364283",
    "gatesPins": [
      {
        "gateId": "044f7270-4cd2-4a8a-8179-5cb9a13357e6",
        "gateName": "Restroom",
        "pin": "12345678"
      }
    ]
  }
}

404 Reservation not found.

{
  "error": {
     "code": 5,
     "title": "NOT_FOUND",
     "status": 404,
     "message": "Reservation not found!"
  }
}