Availability

Check availability for a date

Checks whether the business has availability on a given date or date range for a specific package. Returns inventory information indicating whether the date is available, partially available, or fully booked.

Provide either a single event_date or a range via starts_at and ends_at.

Required permission: availability_read

get/api/v1/availability

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/availability
  • Auth: none declared. Required headers: Api-Key

Query parameters

event_datestring

Date to check (YYYY-MM-DD)

starts_atstring

Start of date range (YYYY-MM-DD)

ends_atstring

End of date range (YYYY-MM-DD)

package_idinteger

Package (event type) ID to check availability for

Headers

Api-Keystring required

Your Integration Key

Response

availability result

Changes

No recorded changes to this operation across all 2 revisions of this API.