Jump to Content
Home
Book an Intro Call
Startup Program
Home
Documentation
API Endpoints
Changelog
v1.0
v3.0.0
Home
Book an Intro Call
Startup Program
Log In
API Endpoints
Log In
v3.0.0
Home
Documentation
API Endpoints
Changelog
List tickets
Search
All
Pages
Start typing to search…
JUMP TO
Welcome
OnSched API 3.0.0
Authentication
Onsched API
Appointment
Book a held appointment
put
Cancel an appointment
put
Confirm an appointment
put
Create an appointment
post
Delete an appointment (holds only)
del
Get appointment by ID
get
Update an appointment
put
List appointments
get
Get appointment custom fields
get
Filter appointments
get
Hold an appointment slot
post
Auth
Generate a new refresh token
post
/v3/auth/token
post
Issue OAuth2 client credentials access token
post
Availability
Get availability
get
ClientId
Delete a client ID
del
List all client IDs for the company
get
Get the primary client ID for the company
get
Generate and set a new client ID
post
Company
Adjust user roles for a company
put
Create a company
post
Delete a company
del
Get company by ID
get
Update a company
put
List companies for the authenticated user
get
Remove users from a company
put
Rotate company API key
put
Rotate OAuth client secret
put
Set users for a company
post
Customer
Create a customer
post
Delete a customer
del
Get customer by ID
get
Update a customer
put
List customers
get
Domain
Delete a company domain
del
List company domains
get
Set company domains
post
ExternalCalendar
Create an external calendar for a resource
post
List external calendars for a resource
get
Create bulk unavailability from external calendars
post
Delete an external calendar
del
Get an external calendar by ID
get
Update an external calendar
put
List available provider calendars for a resource
get
Regenerate external calendar auth URL
put
Select calendars for read/write sync
post
External calendar OAuth callback
get
Geography
Get geography data
get
System
API health check
get
Location
Add resource/service associations to a location
put
Bulk create locations
post
Create a location
post
Set weekly availability for a location
post
Get weekly availability for a location
get
Delete a location
del
Get a location
get
Update a location
put
List locations
get
Remove resource/service associations from a location
put
Replace resource/service associations for a location
post
Public Routes
Book a held appointment (public)
put
Confirm an appointment (public)
put
Create an appointment (public)
post
Get appointment by ID (public)
get
List appointments (public)
get
Get availability (public)
get
Get location by ID (public)
get
List locations (public)
get
Get resource by ID (public)
get
List resources (public)
get
Get service by ID (public)
get
List services (public)
get
Hold an appointment slot (public)
post
Resource
Add location/service associations to a resource
put
Bulk create resources
post
Create a resource
post
Set weekly availability for a resource
post
Get weekly availability for a resource
get
Delete a resource
del
Get a resource
get
Update a resource
put
List resources
get
Remove location/service associations from a resource
put
Replace location/service associations for a resource
post
Service
Add location/resource associations to a service
put
Bulk create services
post
Create a service
post
Set weekly availability for a service
post
Get weekly availability for a service
get
Delete a service
del
Get a service
get
Update a service
put
List services
get
Remove location/resource associations from a service
put
Replace location/resource associations for a service
post
SingleAllocation
Create a single allocation
post
List single allocations
get
Delete a single allocation
del
Get a single allocation
get
Update a single allocation
put
Replace multiple single allocations
post
Timezone
List timezones
get
Unavailability
Create an unavailability block
post
List unavailability
get
List unavailability blocks
get
Get unavailability calendar view
get
Replace unavailability blocks
post
User
Get current user
get
Update a user
put
WeeklyAllocation
Create weekly availability
post
List weekly allocations
get
Delete a weekly allocation
del
Get a weekly allocation
get
Replace weekly allocations
post
EmailTemplate
List email templates
get
Set an email template
post
RecurringBlocks
Create a recurring block
post
Delete recurring blocks
del
List recurring blocks
get
Delete a recurring block
del
Get a recurring block
get
Update a recurring block
put
Tickets
Add a ticket note
post
Create a ticket
post
List tickets
get
Create a ticket message
post
List ticket messages
get
Delete a ticket
del
Get a ticket
get
Update a ticket
put
Webhook
Create a webhook
post
List webhooks
get
Set webhooks
post
Public Endpoints
Security
Recommended Usage
List tickets
get
https://api-stage.onsched.com/v3/tickets
Get all tickets for the company from Groove.
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
Bearer
Log in to use your API keys
RESPONSE
Click
Try It!
to start a request and see the response here!