# Reservations List ## GET /reservations > Retrieve a list of reservations filtered by date type and a date range via fromDate & toDate. Max duration is 31 days. Only confirmed and cancelled reservations are returned. ```json {"openapi":"3.0.0","info":{"title":"Channels Plus Channel API","version":"0.0.1"},"paths":{"/reservations":{"get":{"operationId":"listReservations","description":"Retrieve a list of reservations filtered by date type and a date range via fromDate & toDate. Max duration is 31 days. Only confirmed and cancelled reservations are returned.","parameters":[{"$ref":"#/components/parameters/SmApiId"},{"$ref":"#/components/parameters/SmApiKey"},{"name":"dateType","in":"query","description":"The type of date to filter reservations by. - `checkIn`: Filter by the guest's check-in date (arrival date) - `checkOut`: Filter by the guest's check-out date (departure date) - `bookedOn`: Filter by the date the reservation was created/booked","required":true,"schema":{"type":"string","enum":["checkIn","checkOut","bookedOn"]}},{"name":"fromDate","in":"query","required":true,"schema":{"type":"string","format":"date","description":"The start date of the date range (inclusive). Cannot be more than 365 days in the past."}},{"name":"toDate","in":"query","required":true,"schema":{"type":"string","format":"date","description":"The end date of the date range (inclusive)."}},{"name":"page","in":"query","description":"The page number of the results to fetch.","schema":{"type":"integer","minimum":1,"default":1}},{"name":"perPage","in":"query","description":"The number of results per page.","schema":{"type":"integer","minimum":1,"maximum":200,"default":100,"multipleOf":10}}],"responses":{"200":{"description":"Successful response. Returns a list of reservations.","headers":{"link":{"schema":{"type":"string"},"description":"When a response is paginated, the response headers will include a link header. If the endpoint does not support pagination, or if all results fit on a single page, the link header will be omitted.\nThe link header contains URLs that you can use to fetch additional pages of results. For example, the previous, next, first, and last page of results.\ne.g. '; rel=\"first\", ; rel=\"last\", ; rel=\"next\", ; rel=\"prev\"'\nThe URL for the previous page is followed by rel=\"prev\".\nThe URL for the next page is followed by rel=\"next\".\nThe URL for the last page is followed by rel=\"last\".\nThe URL for the first page is followed by rel=\"first\".\n"}},"content":{"application/json":{"schema":{"type":"array","description":"List of reservations.","items":{"type":"object","additionalProperties":false,"properties":{"bookingReferenceId":{"type":"string","description":"Unique identifier for the booking."},"propertyUuid":{"type":"string","description":"The unique identifier of the property for which the reservation is made."},"bookedOnDate":{"type":"string","format":"date","description":"The date the reservation was made."},"checkInDate":{"type":"string","format":"date","description":"The check-in date for the reservation."},"checkOutDate":{"type":"string","format":"date","description":"The check-out date for the reservation."},"currencyCode":{"type":"string","description":"The currency of the reservation amount."},"paymentTotal":{"type":"number","description":"The total reservation amount in the reservation currency."},"status":{"type":"string","enum":["Confirmed","Cancelled"],"description":"The status of the reservation."},"channelCommissionAmount":{"type":"number","description":"The channel commission amount in the reservation currency."}},"required":["bookingReferenceId","propertyUuid","bookedOnDate","checkInDate","checkOutDate","currencyCode","paymentTotal","status","channelCommissionAmount"]}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}}},"components":{"parameters":{"SmApiId":{"name":"x-sm-api-id","description":"The api id for channel","required":true,"in":"header","schema":{"type":"string"}},"SmApiKey":{"name":"x-sm-api-key","description":"The api key for channel","required":true,"in":"header","schema":{"type":"string"}}},"responses":{"BadRequest":{"description":"Invalid request","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"ServerError":{"description":"Unexpected error occurred","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","required":["errors"],"properties":{"errors":{"minItems":1,"type":"array","description":"An array of error objects, for most errors, this array would only contain one error object. An errors array must contain at least one error object.","items":{"type":"object","required":["code"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"meta":{"type":"object"}}}}}}}}} ``` {% hint style="success" icon="sparkles" %} ## Still have questions? Use the :gitbook-assistant: **Ask** button at the top of the page to chat with our AI assistant — it can help you navigate the guide, understand requirements, and troubleshoot issues. If you need more support, visit [Integration Support](/integration-support/integration-support.md). {% endhint %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developer.siteminder.com/channels-plus-api/reference/reservations-list.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.