Skip to content
SuiteOp Help Center
Dashboard

List reservations for the organization.

GET
/reservations
 
curl --request GET \
  --url 'https://api-us.suiteop.com/api/v1/reservations?dateType=check_in' \
  --header 'Authorization: Bearer <token>'

List reservations with optional filters for status, check-in state, property, date range, and guest search.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
bookingSourceIds
Array<string>
checkInStates
Array<string>
Allowed values: not_checked_in checked_in checked_out
codeStatuses
Array<string>
Allowed values: active pending failed scheduled unknown pending_deletion no_access no_locks failed_deletion awaiting_code installed expired
dateFrom
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d\.\d{3}(?:Z))$/
dateTo
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d\.\d{3}(?:Z))$/
dateType
string
Allowed values: check_in check_out booked_date stay_date
integrationAccountId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
limit
integer
>= 1 <= 100
offset
integer
<= 9007199254740991
propertyGroupIds
Array<string>
propertyIds
Array<string>
search
string
statuses
Array<string>
Allowed values: inquiry declined expired canceled closed reserved confirmed awaiting_payment blocked
verificationStatuses
Array<string>
Allowed values: verified review pending decline unknown

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success.

Media type application/json
object
data
required

Array of matching items.

Array<object>
object
bookingSourceChannel
required
Any of:
string
bookingSourceId
required
Any of:
string
bookingSourceName
required
Any of:
string
checkIn
required
Any of:
string format: date-time
checkInState
required
Any of:
string
checkOut
required
Any of:
string format: date-time
codeStatus
required
Any of:
string
confirmationCode
required
Any of:
string
createdAt
required
string format: date-time
etaCheckIn
required
Any of:
string format: date-time
etaCheckOut
required
Any of:
string format: date-time
externalReservationId
required
Any of:
string
guestCount
required
Any of:
number
guestEmail
required
Any of:
string
guestFirstName
required
Any of:
string
guestLastName
required
Any of:
string
id
required
string
isAutoScheduleDisabled
required
boolean
nightCount
required
Any of:
number
pmsProvider
required
Any of:
string
portalLoadCount
required
number
propertyBathroomCount
required
Any of:
number
propertyBedCount
required
Any of:
number
propertyGroupName
required
Any of:
string
propertyId
required
Any of:
string
propertyName
required
Any of:
string
propertyNickname
required
Any of:
string
sourceText
required
Any of:
string
status
required
Any of:
string
subtotalCents
required
Any of:
number
updatedAt
required
string format: date-time
verificationStatus
required
Any of:
string
meta
required

Response metadata including pagination.

object
pagination
required

Present on list responses.

object
limit
required

Page size used for this request.

integer
offset
required

Number of items skipped.

integer
total
required

Total number of matching items (across all pages).

integer
requestId
required

Unique identifier for this request.

string
pagination
required

Pagination metadata included on list responses.

object
limit
required

Page size used for this request.

integer
offset
required

Number of items skipped.

integer
total
required

Total number of matching items (across all pages).

integer
Example generated
{
  "data": [
    {
      "bookingSourceChannel": "example",
      "bookingSourceId": "example",
      "bookingSourceName": "example",
      "checkIn": "2026-04-15T12:00:00Z",
      "checkInState": "example",
      "checkOut": "2026-04-15T12:00:00Z",
      "codeStatus": "example",
      "confirmationCode": "example",
      "createdAt": "2026-04-15T12:00:00Z",
      "etaCheckIn": "2026-04-15T12:00:00Z",
      "etaCheckOut": "2026-04-15T12:00:00Z",
      "externalReservationId": "example",
      "guestCount": 1,
      "guestEmail": "example",
      "guestFirstName": "example",
      "guestLastName": "example",
      "id": "example",
      "isAutoScheduleDisabled": true,
      "nightCount": 1,
      "pmsProvider": "example",
      "portalLoadCount": 1,
      "propertyBathroomCount": 1,
      "propertyBedCount": 1,
      "propertyGroupName": "example",
      "propertyId": "example",
      "propertyName": "example",
      "propertyNickname": "example",
      "sourceText": "example",
      "status": "example",
      "subtotalCents": 1,
      "updatedAt": "2026-04-15T12:00:00Z",
      "verificationStatus": "example"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute for this API key.

X-RateLimit-Remaining
integer

Remaining requests in the current rate-limit window.

X-RateLimit-Reset
integer

Unix epoch seconds when the rate-limit window resets.

X-Request-Id
string

Unique identifier for this request (matches meta.requestId in the body).

400

Section titled “400 ”

400

Media type application/json
ValidationError

Error envelope returned for HTTP 400 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: validation_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "validation_error"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

401

Section titled “401 ”

401

Media type application/json
AuthenticationError

Error envelope returned for HTTP 401 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: authentication_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "authentication_error"
  }
}

Headers

Section titled “Headers ”
X-Request-Id
string

Request correlation id (also in meta.requestId).

403

Section titled “403 ”

403

Media type application/json
AuthorizationError

Error envelope returned for HTTP 403 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: authorization_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "authorization_error"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

404

Section titled “404 ”

404

Media type application/json
NotFoundError

Error envelope returned for HTTP 404 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: not_found_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "not_found_error"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

409

Section titled “409 ”

409

Media type application/json
ConflictError

Error envelope returned for HTTP 409 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: conflict_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "conflict_error"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

422

Section titled “422 ”

422

Media type application/json
BusinessRuleError

Error envelope returned for HTTP 422 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: business_rule_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "business_rule_error"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

429

Section titled “429 ”

429

Media type application/json
RateLimitError

Error envelope returned for HTTP 429 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: rate_limit_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "rate_limit_error"
  }
}

Headers

Section titled “Headers ”
Retry-After
integer

Number of seconds to wait before retrying.

X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

500

Section titled “500 ”

500

Media type application/json
InternalError

Error envelope returned for HTTP 500 responses.

object
error
required
object
code
required

Machine-readable error code.

string
details

Optional structured details (omitted when undefined).

object
key
additional properties
any
message
required

Human-readable error message.

string
type
required

Error type.

string
Allowed values: internal_error
meta
required
object
requestId
required
string
Example 
{
  "error": {
    "type": "internal_error"
  }
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests per minute.

X-RateLimit-Remaining
integer

Remaining requests in the current window.

X-RateLimit-Reset
integer

Unix epoch seconds when the window resets.

X-Request-Id
string

Request correlation id (also in meta.requestId).

© 2026 SuiteOp Inc. All rights reserved.
Website Dashboard Status Contact Support