List blocks

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this endpoint to retrieve the blocks that match your query parameters.

Before you call this endpoint

  1. Include an access token with at least one of these scopes: blocks.read, reservations.read, or reservations.manage.
  2. Add query parameters when you want to filter the result set.
  3. Use the expand parameter when you want the response to include embedded resources.

What this endpoint does

The API returns the blocks that match the filters you send with the request. If you do not send any filters, the API returns all blocks available in your request context.

Authorization

Send an access token that includes at least one of these scopes:

  • blocks.read
  • reservations.read
  • reservations.manage
Query Params
string
propertyIds
array of strings
propertyIds
status
array of strings
status
unitGroupIds
array of strings
unitGroupIds
ratePlanIds
array of strings
ratePlanIds
timeSliceDefinitionIds
array of strings
timeSliceDefinitionIds
unitGroupTypes
array of strings
unitGroupTypes
string
enum
Allowed:
date-time
date-time
integer
Defaults to 1
integer
Defaults to 500
expand
array of strings
expand
Responses

204

No blocks found.

400

Bad request.

401

You are unauthorized.

403

Forbidden.

404

The Request-URI could not be found.

499

Client closed request.

500

An unexpected error occurred.

503

The server is currently unavailable. Please try later.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json