Availability

Check detailed availability

Returns detailed availability information for a specific date, time, and resource combination. Use this to check whether a particular staff member, add-on, or backdrop is available for a given time slot.

This endpoint supports multiple lookup types and can check availability for packages, add-ons, backdrops, and specific staff members simultaneously.

Required permission: availability_read

get/api/v1/availability/detailed

Request

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

Query parameters

starts_at_datestring

Date to check (YYYY-MM-DD)

starts_at_timestring

Start time to check

ends_at_timestring

End time to check

starts_atstring

Start datetime (ISO 8601)

ends_atstring

End datetime (ISO 8601)

package_idinteger

Package (event type) ID

add_on_idinteger

Add-on ID to check availability for

backdrop_idinteger

Backdrop ID to check availability for

staff_idinteger

Staff member ID to check availability for

lookup_typestring

Type of availability lookup

quantityinteger

Quantity to check availability for

Headers

Api-Keystring required

Your Integration Key

Response

detailed availability result

Changes

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