Sharetribe icon

Sharetribe

Allows interaction with the Sharetribe Integration API

Actions28

Listing → Get Listing Availability

AI-generated

Summary

Retrieve availability timeslots for a listing.

Inputs

  • returnAll — Whether to return all results or only up to the limit.
  • limit — Maximum number of results to return when returnAll is false.
  • listingId (required) — The UUID of the listing to query for available booking timeslots.
  • start (required) — Start date‑time in UTC for the availability range.
  • end (required) — End date‑time in UTC for the availability range.
  • options — Configuration for expanding and grouping time slots; contains expandTimeSlots, minDurationStartingInInterval, and timeSlotGrouping settings.

Output shape

An array of time‑slot objects describing the available periods, optionally expanded or grouped.

The response may be paged; fields such as expandTimeSlots and group settings influence the structure but are always present as part of the returned items.

Examples

Example 1: Check the next 3 days of availability for a specific listing.

listingId = '550e8400-e29b-41d4-a716-446655440000', start = '2025-01-01T00:00:00Z', end = '2025-01-04T00:00:00Z', returnAll = false, limit = 50

Example 2: Get fully expanded availability with grouping to align to 45‑minute slots.

listingId = '550e8400-e29b-41d4-a716-446655440000', start = '2025-02-10T08:30:00Z', end = '2025-02-11T00:00:00Z', expandTimeSlots = true, minDurationStartingInInterval = {unit: 'minutes', value: 45}, timeSlotGrouping = {duration: {unit: 'minutes', value: 45}, alignmentOptions: {intervalAlign: '2025-02-10T08:30:00Z'}, limitOptions: {maxPerInterval: 1}}

Example 3: Fetch all available timeslots for a listing in a single request.

listingId = '550e8400-e29b-41d4-a716-446655440000', returnAll = true

Links

Discussion