Onsched Setup API

OnSched Setup API

API version: v1

Auth

OAuth2

Base URL

https://sandbox-api.onsched.com/

Setup

1. Configure auth: OAuth2
2. GET /setup/v1/appointments -- verify access
3. POST /setup/v1/businessusers -- create first businessusers

Endpoints

139 endpoints across 1 groups. See references/api-spec.lap for full details.

setup

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all appointments?" -> GET /setup/v1/appointments
• "Get appointment details?" -> GET /setup/v1/appointments/{id}
• "Update a resource?" -> PUT /setup/v1/appointments/{id}/reassign/resource/{resourceId}
• "List all businessusers?" -> GET /setup/v1/businessusers
• "Create a businessuser?" -> POST /setup/v1/businessusers
• "Get businessuser details?" -> GET /setup/v1/businessusers/{id}
• "Update a businessuser?" -> PUT /setup/v1/businessusers/{id}
• "Delete a businessuser?" -> DELETE /setup/v1/businessusers/{id}
• "List all permissions?" -> GET /setup/v1/businessusers/permissions
• "List all companies?" -> GET /setup/v1/businessusers/{email}/companies
• "List all calendars?" -> GET /setup/v1/calendars
• "Create a calendar?" -> POST /setup/v1/calendars
• "Get calendar details?" -> GET /setup/v1/calendars/{id}
• "Update a calendar?" -> PUT /setup/v1/calendars/{id}
• "Delete a calendar?" -> DELETE /setup/v1/calendars/{id}
• "List all services?" -> GET /setup/v1/calendars/{id}/services
• "List all blocks?" -> GET /setup/v1/calendars/{id}/blocks
• "Get block details?" -> GET /setup/v1/calendars/blocks/{id}
• "Create a block?" -> POST /setup/v1/calendars/{id}/block
• "Update a block?" -> PUT /setup/v1/calendars/block/{id}
• "Delete a block?" -> DELETE /setup/v1/calendars/block/{id}
• "List all companies?" -> GET /setup/v1/companies
• "Create a company?" -> POST /setup/v1/companies
• "List all domains?" -> GET /setup/v1/companies/domains
• "Create a domain?" -> POST /setup/v1/companies/domains
• "Get domain details?" -> GET /setup/v1/companies/domains/{id}
• "Update a domain?" -> PUT /setup/v1/companies/domains/{id}
• "Delete a domain?" -> DELETE /setup/v1/companies/domains/{id}
• "List all regions?" -> GET /setup/v1/companies/regions
• "Create a region?" -> POST /setup/v1/companies/regions
• "Get region details?" -> GET /setup/v1/companies/regions/{id}
• "Update a region?" -> PUT /setup/v1/companies/regions/{id}
• "Delete a region?" -> DELETE /setup/v1/companies/regions/{id}
• "List all templates?" -> GET /setup/v1/companies/email/templates
• "Get template details?" -> GET /setup/v1/companies/email/templates/{templateName}
• "List all master?" -> GET /setup/v1/companies/email/templates/master
• "Create a master?" -> POST /setup/v1/companies/email/templates/master
• "Get timezone details?" -> GET /setup/v1/companies/timezones/{date}
• "List all customers?" -> GET /setup/v1/customers
• "Get customer details?" -> GET /setup/v1/customers/{id}
• "List all privacy?" -> GET /setup/v1/customers/{id}/privacy
• "List all locations?" -> GET /setup/v1/locations
• "Create a location?" -> POST /setup/v1/locations
• "Get location details?" -> GET /setup/v1/locations/{id}
• "Update a location?" -> PUT /setup/v1/locations/{id}
• "Delete a location?" -> DELETE /setup/v1/locations/{id}
• "Create a bulk?" -> POST /setup/v1/locations/bulk
• "Update a scope?" -> PUT /setup/v1/locations/{id}/settings/scope/{settingsScope}
• "Update a holiday?" -> PUT /setup/v1/locations/{id}/holidays/{holidayId}/{closed}
• "List all services?" -> GET /setup/v1/locations/{id}/services
• "Create a service?" -> POST /setup/v1/locations/{id}/services
• "Get service details?" -> GET /setup/v1/locations/services/{id}
• "Delete a service?" -> DELETE /setup/v1/locations/services/{id}
• "Create a uploadimage?" -> POST /setup/v1/locations/{id}/uploadimage
• "List all templates?" -> GET /setup/v1/locations/{id}/email/templates
• "Create a template?" -> POST /setup/v1/locations/{id}/email/templates
• "Get template details?" -> GET /setup/v1/locations/{id}/email/templates/{templateName}
• "Delete a template?" -> DELETE /setup/v1/locations/{id}/email/templates/{templateName}
• "List all master?" -> GET /setup/v1/locations/{id}/email/templates/master
• "Create a master?" -> POST /setup/v1/locations/{id}/email/templates/master
• "List all account?" -> GET /setup/v1/locations/{id}/google/service/account
• "Create a account?" -> POST /setup/v1/locations/{id}/google/service/account
• "List all appointmentreminders?" -> GET /setup/v1/locations/{id}/appointmentreminders
• "List all resourcegroups?" -> GET /setup/v1/resourcegroups
• "Create a resourcegroup?" -> POST /setup/v1/resourcegroups
• "Get resourcegroup details?" -> GET /setup/v1/resourcegroups/{id}
• "Update a resourcegroup?" -> PUT /setup/v1/resourcegroups/{id}
• "Delete a resourcegroup?" -> DELETE /setup/v1/resourcegroups/{id}
• "List all resources?" -> GET /setup/v1/resources
• "Create a resource?" -> POST /setup/v1/resources
• "Get resource details?" -> GET /setup/v1/resources/{id}
• "Update a resource?" -> PUT /setup/v1/resources/{id}
• "Delete a resource?" -> DELETE /setup/v1/resources/{id}
• "Get google details?" -> GET /setup/v1/resources/{id}/calendar/auth/google/{googleEmailAddress}
• "Get outlook details?" -> GET /setup/v1/resources/{id}/calendar/auth/outlook/{outlookEmailAddress}
• "List all timezones?" -> GET /setup/v1/resources/timezones
• "Create a bulk?" -> POST /setup/v1/resources/bulk
• "Update a appointment?" -> PUT /setup/v1/resources/{id}/reassign/appointments/{resourceId}
• "List all availability?" -> GET /setup/v1/resources/{id}/availability
• "List all allocations?" -> GET /setup/v1/resources/{id}/allocations
• "Create a allocation?" -> POST /setup/v1/resources/{id}/allocations
• "Get allocation details?" -> GET /setup/v1/resources/allocations/{id}
• "Update a allocation?" -> PUT /setup/v1/resources/allocations/{id}
• "Delete a allocation?" -> DELETE /setup/v1/resources/allocations/{id}
• "List all blocks?" -> GET /setup/v1/resources/{id}/blocks
• "Get block details?" -> GET /setup/v1/resources/blocks/{id}
• "Create a block?" -> POST /setup/v1/resources/{id}/block
• "Update a block?" -> PUT /setup/v1/resources/block/{id}
• "Delete a block?" -> DELETE /setup/v1/resources/block/{id}
• "Create a service?" -> POST /setup/v1/resources/{id}/services
• "Create a uploadimage?" -> POST /setup/v1/resources/{id}/uploadimage
• "List all servicegroups?" -> GET /setup/v1/servicegroups
• "Create a servicegroup?" -> POST /setup/v1/servicegroups
• "Get servicegroup details?" -> GET /setup/v1/servicegroups/{id}
• "Update a servicegroup?" -> PUT /setup/v1/servicegroups/{id}
• "Delete a servicegroup?" -> DELETE /setup/v1/servicegroups/{id}
• "List all services?" -> GET /setup/v1/services
• "Create a service?" -> POST /setup/v1/services
• "Get service details?" -> GET /setup/v1/services/{id}
• "Update a service?" -> PUT /setup/v1/services/{id}
• "Delete a service?" -> DELETE /setup/v1/services/{id}
• "List all resources?" -> GET /setup/v1/services/{id}/resources
• "List all blocks?" -> GET /setup/v1/services/{id}/blocks
• "Get block details?" -> GET /setup/v1/services/blocks/{id}
• "Create a block?" -> POST /setup/v1/services/{id}/block
• "Update a block?" -> PUT /setup/v1/services/block/{id}
• "Delete a block?" -> DELETE /setup/v1/services/block/{id}
• "List all calendar?" -> GET /setup/v1/services/{id}/calendar
• "Create a calendar?" -> POST /setup/v1/services/calendar
• "Delete a calendar?" -> DELETE /setup/v1/services/calendar/{id}
• "List all availability?" -> GET /setup/v1/services/{id}/availability
• "List all allocations?" -> GET /setup/v1/services/{id}/allocations
• "Create a allocation?" -> POST /setup/v1/services/{id}/allocations
• "Get allocation details?" -> GET /setup/v1/services/allocations/{id}
• "Update a allocation?" -> PUT /setup/v1/services/allocations/{id}
• "Delete a allocation?" -> DELETE /setup/v1/services/allocations/{id}
• "Create a bulk?" -> POST /setup/v1/services/{id}/allocations/bulk
• "Create a uploadimage?" -> POST /setup/v1/services/{id}/uploadimage
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP