API Reference

Get Bookings

get
https://api.appointedd.com/v1/bookings

Get one or more of the customers in your Appointedd organisation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response
Returns zero, one, or more Booking objects that match your query.

Query Params
int32
Defaults to 10

Maximum number of bookings to return per page. Must be a number between 1 and 100.

string

ID of the booking at the start of the page to return. You can use this to navigate to the next page of your current page by using the ID of the next property in your current page's response.

string

ID of the booking at the end of the page to return. You can use this to navigate to the previous page from your current page by using the ID of the prev property in your current page's response.

string
enum
Defaults to natural

Property on the bookings to sort with.

Allowed:
string
enum
Defaults to descending

Order to apply to the sorting used on the returned bookings.

Allowed:
string

Filters the returned bookings by the date and time they end at (including the after buffer), returning only those that end at or before this date and time. Must be a valid ISO8601 formatted date and time.

string

Filters the returned bookings by the date and time they start on (including the after buffer), returning only those that start on or after this date and time. Must be a valid ISO8601 formatted date and time.

string

Filters the returned bookings by the date and time they were created on, returning only those that were created on or before this date and time. Must be a valid ISO8601 formatted date and time.

string

Filters the returned bookings by the date and time they were created on, returning only those that were created on or after this date and time. Must be a valid ISO8601 formatted date and time.

string

Filters the returned bookings by the date and time they were last updated on, returning only those that were last updated on or before this date and time. Must be a valid ISO8601 formatted date and time.

string

Filters the returned bookings by the date and time they were last updated on, returning only those that were last updated on or after this date and time. Must be a valid ISO8601 formatted date and time.

ids
array of strings

Filters the returned bookings by booking IDs, returning only those that have an ID that match at least one of the booking IDs here.

ids
categories
array of strings

Filters the returned bookings by service category IDs, returning only those that have a service which is assigned to a category that matches one of the category IDs here. Supports both a single category ID or an array of category IDs.

categories
services
array of strings

Filters the returned bookings by service IDs, returning only those that have a service ID that matches one of the service IDs here. Supports both a single service ID or an array of service IDs.

services
customers
array of strings

Filters the returned bookings by customer IDs, returning only those that have a customer ID that matches one of the customer IDs here. Supports both a single customer ID or an array of customer IDs.

customers
resources
array of strings

Filters the returned bookings by resource IDs, returning only those that have a resource ID that matches one of the resource IDs here. Supports both a single resource ID or an array of resource IDs.

resources
string

A valid, non-deprecated, IANA Timezone. Any property which is formatted as a date and time will be returned in this timezone.

string
enum

Filters the returned bookings by status, returning only those that have a status that matches at least one of the provided statuses'.

Allowed:
boolean
Defaults to false

If set to true only customers whose IDs match at least one of the IDs in the ids query parameter will be returned on the bookings. This is useful if your bookings have a large number of customers on them.

Responses

Updated 10 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago

Did this page help you?