Build secure and scalable custom apps for onboarding and setup. Our flexible API provides many options for configuration. Take the API for a test drive. Just click on the Authorize button below and authenticate. You can access our demo company profile if you are not a customer, or your own prof
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://sandbox-api.onsched.com
auth: o a u t h 2
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Build secure and scalable custom apps for onboarding and setup. Our flexible API provides many options for configuration. Take the API for a test drive. Just click on the Authorize button below and authenticate. You can access our demo company profile if you are not a customer, or your own profile by using your assigned ClientId and Secret. The API has two interfaces, consumer and setup.
| method | path | what the vendor says it does |
|---|---|---|
GET | /setup/v1/appointments | List Appointments Use this endpoint to return a List of Appointments. Use the offset and limit parameters to c |
GET | /setup/v1/appointments/{id} | Get Appointment Use this endpoint to return an Appointment object. A valid appointment id is required. Find ap |
PUT | /setup/v1/appointments/{id}/reassign/resource/{resourceId} | Reassign Appointment Use this endpoint to Reassign an appointment from one resource to another. The result ret |
GET | /setup/v1/businessusers | List Users Use this endpoint to return a List of Business Users and their Roles. The results are returned in p |
POST | /setup/v1/businessusers | Create User Use this endpoint to Create a Business User. If not specified, the business location defaults to t |
GET | /setup/v1/businessusers/permissions | List User Permissions Use this endpoint to return a List of Business User Permissions by Role. Results are ret |
GET | /setup/v1/businessusers/{email}/companies | List User Companies Use this endpoint to return a List of Companies associated with the business users email r |
GET | /setup/v1/businessusers/{id} | Get User Use this endpoint to return a Business User object. A valid businessUser id is required. Find busines |
PUT | /setup/v1/businessusers/{id} | Update User Use this endpoint to Update a Business User. A valid businessUser id is required. Business Ro |
DELETE | /setup/v1/businessusers/{id} | Delete User Use this endpoint to permanently Delete a Business User. A valid businessUser id is required. Busi |
GET | /setup/v1/calendars | List Calendars Use this endpoint to return a List of Calendars from the requested location. If not specified, |
POST | /setup/v1/calendars | DEPRECATING: Create DEPRECATING: Create Calendar We are no longer supporting Multiple Calendar Functional |
PUT | /setup/v1/calendars/block/{id} | Update Calendar Block Use this endpoint to Create a Calendar Block. A valid calendarBlock id is required. Refe |
DELETE | /setup/v1/calendars/block/{id} | Delete Calendar Block Use this endpoint to permanently Delete a calendar block. A valid calendarBlock id is re |
GET | /setup/v1/calendars/blocks/{id} | Get Calendar Block Use this endpoint to return a Calendar Block. A valid calendarBlock id is required. Calend |
GET | /setup/v1/calendars/{id} | Get Calendar Use this endpoint to return a Calendar object. A valid calendar id is required. Calendars |
PUT | /setup/v1/calendars/{id} | Update Calendar Use this endpoint to Update a calendar object. A valid calendar id is required. When your comp |
DELETE | /setup/v1/calendars/{id} | Delete Calendar Use this endpoint to Delete a calendar object. A valid calendar id is required. The calendar i |
POST | /setup/v1/calendars/{id}/block | Create Calendar Block Use this endpoint to Create a Calendar Block. A valid calendar id is required. Required |
GET | /setup/v1/calendars/{id}/blocks | List Calendar Blocks Use this endpoint to return a List of Calendar Blocks for the requested calendar. A valid |
PUT | /setup/v1/calendars/{id}/recover | Recover Calendar Use this endpoint to Recover a previously deleted calendar object. A valid calendar id is req |
GET | /setup/v1/calendars/{id}/services | List Calendar Services Use this endpoint to return a List of Linked Services of a calendar object. A valid cal |
GET | /setup/v1/companies | Get Company Use this endpoint to return the Authorized Company information. The company is the main entity tha |
POST | /setup/v1/companies | Create Company Use this endpoint to Create a new authorized company. Note: Special API Partner credential |
PUT | /setup/v1/companies | Update Company Use this endpoint to Update the authorized company information. Your client credentials resolve |
GET | /setup/v1/companies/domains | List Company Domains Use this endpoint to return a List of Company Domains for the authorized company. To shar |
POST | /setup/v1/companies/domains | Create Company Domain Use this endpoint to Create an OnSchedJs domain for your authorized company. To share th |
GET | /setup/v1/companies/domains/{id} | Get Company Domain Use this endpoint to return a Company Domain object. A valid companyDomain id is required. |
PUT | /setup/v1/companies/domains/{id} | Update Company Domain Use this endpoint to Update an OnSchedJs domain for your authorized company. A valid com |
DELETE | /setup/v1/companies/domains/{id} | Delete Company Domain Use this endpoint to Delete an OnSchedJs domain from your authorized company. A valid co |
GET | /setup/v1/companies/email/templates | List Email Templates Use this endpoint to return a List of Email Templates that are provided and may be custom |
GET | /setup/v1/companies/email/templates/master | Get Master Template Settings Use this endpoint to return the Master Email Template Settings. Settings exist fo |
POST | /setup/v1/companies/email/templates/master | Create Master Template Settings Use this endpoint to Create Custom Master Email Template Settings. Settings ex |
DELETE | /setup/v1/companies/email/templates/master | Delete Master Template Settings Use this endpoint to Delete Custom Master Email Template Settings. Deleting a |
GET | /setup/v1/companies/email/templates/{templateName} | Get Email Template Use this endpoint to return the requested Email Template. If it wasn't customized the defau |
GET | /setup/v1/companies/regions | List Regions Use this endpoint to return a list of Regions in the authorized company. The results are returned |
POST | /setup/v1/companies/regions | Create Region Use this endpoint to Create a region object. Regions can be mapped to business locations. They c |
GET | /setup/v1/companies/regions/{id} | Get Region Use this endpoint to return a Region object. A valid region id is required. Companies |
PUT | /setup/v1/companies/regions/{id} | Update Region Use this endpoint to Update a region object. A valid region id is required. Companies |
DELETE | /setup/v1/companies/regions/{id} | Delete Region Use this endpoint to Delete a region object. A valid region id is required. If the region is rel |
and 98 more operation(s) in this specification, all searchable.
specification origin: https://sandbox-api.onsched.com/swagger/setup/swagger.json
Build secure and scalable custom apps for Online Booking. Our flexible API provides many options for availability and booking. Take the API for a test drive. Just click on the Authorize button below and authenticate. You can access our demo company profile if you are not a customer, or your own profile by using your assigned ClientId and Secret. The API has two interfaces, consumer and set
| method | path | what the vendor says it does |
|---|---|---|
GET | /consumer/v1/appointments | Get Appointments Use this endpoint to return a List of Appointments. Use the offset and limit parameters to co |
POST | /consumer/v1/appointments | Create Appointment Use this endpoint to Create a new appointment. The appointment will be created with an "IN" |
GET | /consumer/v1/appointments/bookingfields | Get Custom Fields Labels Use this endpoint to return a locations Appointment Booking Fields. Appointment booki |
GET | /consumer/v1/appointments/customfields | Get Custom Fields List Use this endpoint to return a locations Appointment Custom Field definitions. Appointme |
GET | /consumer/v1/appointments/{id} | Get Appointment Use this endpoint to return an Appointment object. A valid appointment id is required. For mor |
DELETE | /consumer/v1/appointments/{id} | Delete Appointment Use this endpoint to permanently Delete an appointment. Only appointments with a of "IN" st |
PUT | /consumer/v1/appointments/{id}/book | Book Appointment Use this endpoint to Book an appointment. Only appointments with an "IN" status, Initial, can |
PUT | /consumer/v1/appointments/{id}/cancel | Cancel Appointment Use this endpoint to Cancel an appointment booking or reservation. Only appointments with a |
PUT | /consumer/v1/appointments/{id}/confirm | Confirm Appointment Use this endpoint to Confirm an appointment. This updates the boolean confirmed field to T |
PUT | /consumer/v1/appointments/{id}/noshow | Set NoShow Status Use this endpoint to change the status of an appointment from "BK", Booked to "NS", NoShow. |
PUT | /consumer/v1/appointments/{id}/reschedule | Reschedule Appointment Use this endpoint to Reschedule an appointment booking. Only appointments in "BK", book |
PUT | /consumer/v1/appointments/{id}/reserve | Reserve Appointment Use this endpoint to Reserve an appointment. Only appointments with an "IN" status, Initia |
GET | /consumer/v1/availability/{serviceId}/{startDate}/{endDate} | Get Available Times Choose your search criteria carefully. Availability is an expensive call. If you searc |
GET | /consumer/v1/availability/{serviceId}/{startDate}/{endDate}/days | Get Available Days This endpoint will return Day Level Availability for the range of dates requested. For exam |
GET | /consumer/v1/availability/{serviceId}/{startDate}/{endDate}/unavailable | Get Unavailable Times This endpoint is used to show Unavailable times and provides valuable information as to |
GET | /consumer/v1/customers | List Customers Use this endpoint to return a List of Customers. The results are returned in pages. Use the off |
POST | /consumer/v1/customers | Create Customer Use this endpoint to Create a new Customer. A customer object is automatically created with th |
GET | /consumer/v1/customers/bookingfields | Get Customer Booking Fields Use this endpoint to return Customer Booking Fields. Customer booking fields are s |
GET | /consumer/v1/customers/countries | List Country Codes Use this endpoint to return a List of Countries with their associated Country Code. Country |
GET | /consumer/v1/customers/customfields | Get Customer Custom Fields Use this endpoint to return Customer Custom Fields. Customer custom fields are stor |
GET | /consumer/v1/customers/states | List Country States Use this endpoint to return a List of Countries with their associated State Codes. Supply |
GET | /consumer/v1/customers/{id} | Get Customer Use this endpoint to return a Customer object. A valid customer id is required. Find customer id' |
PUT | /consumer/v1/customers/{id} | Update Customer Use this endpoint to Update a Customer object. A valid customer id is required. Note: Blank fi |
DELETE | /consumer/v1/customers/{id} | Delete Customer Use this endpoint to permanently Delete a Customer object. A valid customer id is required. Cu |
GET | /consumer/v1/locations | List Locations Use this endpoint to return a List of Business Locations. The results are returned in pages. Us |
GET | /consumer/v1/locations/{id} | Get Location Use this endpoint to return a Location object. A valid business location id is required. Find all |
GET | /consumer/v1/resourcegroups | List Resource Groups Use this endpoint to return a list of Resource Groups for the requested location. If not |
GET | /consumer/v1/resourcegroups/{id} | Get Resource Group Use this endpoint to return a Resource Group object. A valid resourceGroup id is required. |
GET | /consumer/v1/resources | List Resources Use this endpoint to return a List of Resources associated with a business location. If not spe |
GET | /consumer/v1/resources/{id} | Get Resource Use this endpoint to return a Resource object. A valid resource id is required. Find resource id' |
GET | /consumer/v1/resources/{id}/services | Get Resource Linked Services Use this endpoint to get a List of Linked Services associated with the resource r |
GET | /consumer/v1/servicegroups | List Service Groups Use this endpoint to return a list of Service Groups for the requested location. If not sp |
GET | /consumer/v1/servicegroups/{id} | Get Service Group Use this endpoint to return a Service Group object. A valid serviceGroup id is required. Fin |
GET | /consumer/v1/services | List Services Use this endpoint to List Services available at your business location and/or company. If not sp |
GET | /consumer/v1/services/allocations/{id} | Get Service Allocation Use this endpoint to return a Service Allocation object. A valid serviceAllocation id i |
GET | /consumer/v1/services/{id} | Get Service Use this endpoint to return a Service object. A valid service id is required. Find service id's by |
GET | /consumer/v1/services/{id}/allocations | List Service Allocations Use this endpoint to return a List of Service Allocations associated with the request |
GET | /consumer/v1/services/{id}/resources | List Resources for Service Use this endpoint to return a list of Resources that provide the Service requested. |
specification origin: https://sandbox-api.onsched.com/swagger/consumer/swagger.json
Endpoints for system utilities. e.g.Health
| method | path | what the vendor says it does |
|---|
specification origin: https://sandbox-api.onsched.com/swagger/utility/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.