GET /consumer/v1/appointments

onsched.com:consumer

Summary: Get Appointments
Operation ID: —
Auth: unknown
Description

<p>Use this endpoint to return a <b>List of Appointments</b>. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further. For more information: <a href="https://onsched.readme.io/docs/appointments-overview">Appointments Overview</a></p>

Parameters (15)

bookedBy (string, query, optional)

Filter by the email of who booked

calendarId (string, query, optional)

Filter by calendar

customerId (string, query, optional)

Filter by customer

email (string, query, optional)

Filter by email address

endDate (string, query, optional)

Format YYYY-MM-DD. Filter on/before endDate

lastname (string, query, optional)

Filter by lastname or part of it

limit (integer, query, optional)

Page limit, default 20, max 100

locationId (string, query, optional)

id of business location

offset (integer, query, optional)

Starting row of page, default 0

phone (string, query, optional)

Filter by phone number or part of it

resourceId (string, query, optional)

Filter by resource

serviceAllocationId (string, query, optional)

Filter by service allocation

serviceId (string, query, optional)

Filter by service

startDate (string, query, optional)

Format YYYY-MM-DD. Filter by on/after startDate

status (string, query, optional)

Filter by status: IN, BK, CN, RE, RS

No probe data for this endpoint yet.