Find Available Intervals

post

https://json-api.appointedd.com/v2/availability/intervals/search

Search for available time intervals for booking. This endpoint proxies requests to the Chronos availability engine while maintaining compatibility with existing request structures.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

ranges

array of objects

required

length ≥ 1

One or more ranges of dates & times to query for available intervals.

ranges*

start

date-time

required

Starting date and time of the range to query. Must be in a valid ISO8601 formatted string.

end

date-time

required

Ending date and time of the range to query. Must be in a valid ISO8601 formatted string.

accounts

array of objects

required

length ≥ 1

One or more account-specific availability requests. Each account will have its own service, resource, and resource group IDs.

accounts*

accountId

string

required

Unique identifier of the account (organisation) for this availability request.

serviceId

string

required

Unique identifier of the service in this organisation to use when calculating the available intervals.

resourceIds

array of strings

One or more unique identifiers of resources in this organisation to find available intervals for. If not set this defaults to all of the resources assigned to the service you specified.

resourceIds

resourceGroupIds

array of strings

One or more unique identifiers of resource groups in this organisation whose resources you want to find available intervals. Mutually exclusive with resourceIds.

resourceGroupIds

buffers

object

Controls the amount of time before and/or after a booking that must not contain any other bookings, breaks, or external events. If you do not specify any buffers then they will either be loaded from a service if you have given one, or default to query with no buffers.

duration

integer

≥ 1

Number of continuous minutes of time from the start of an interval that must be free for an interval to be considered available. If you do not specify the parts property or this property, and you have specified a service property, the default duration or parts for that service will be used. If you specify the parts property in this request this property will be ignored.

parts

array of objects

Parts that define the structure of the booking time.

parts

spaces

integer

≥ 1

Defaults to 1

Number of spaces that are required. This is used to exclude any group bookings that do not have enough spaces.

timezone

string

Defaults to Europe/London

Name of an IANA timezone to return the resulting dates & times in.

ignorePastRestriction

boolean

Defaults to false

If set to true availability will not be restricted by the current date and time. By default this is set to false and any date and time before the current date and time will be considered as unavailable.

ignoreNoticeRestriction

boolean

Defaults to false

If set to true availability will not be restricted by your organisation's or service's notice period settings. By default this is set to false and any date and time before the number of minutes/hours/days added onto the current date and time will be considered as unavailable.

ignoreBookings

array of strings

One or more unique identifiers of bookings in your organisation to ignore for the purposes of this availability query. This means that it will not block availability and if it is a group booking it will not be returned if it is available.

ignoreBookings

ignoreServiceAssignment

boolean

Defaults to false

If set to true, the request will not fail if the resource on this booking is not assigned to the service on this booking.

ignoreServiceSchedule

boolean

Defaults to false

If set to true availability will not be restricted by the service's schedule. By default this is set to false and any date and time outside of the service's schedule will be considered as unavailable.

ignoreGroupSetting

boolean

Defaults to false

If set to true the availability will return bookings that have enough space as group bookings, regardless if they have online group bookings turned on.

ignoreBlockRestriction

boolean

Defaults to false

If set to true availability will ignore the block after setting on your account.

200Default Response

401Unauthorized