Onsched Setup
OnSched Setup is an appointment scheduling API for configuring booking resources such as locations, services, staff, and availability.
- Base URL:
https://sandbox-api.onsched.com - Auth: OAuth 2.0 client-credentials — the tool fetches a token from
https://sandbox-identity.onsched.com/connect/tokenusing yourclientId/clientSecret, then calls the API.
Operations
get_setup_v1_appointments— GET /setup/v1/appointments — List Appointmentsget_setup_v1_appointments_id— GET /setup/v1/appointments/{id} — Get Appointmentget_setup_v1_businessusers— GET /setup/v1/businessusers — List Usersget_setup_v1_businessusers_permissions— GET /setup/v1/businessusers/permissions — List User Permissionsget_setup_v1_businessusers_email_companies— GET /setup/v1/businessusers/{email}/companies — List User Companiesget_setup_v1_businessusers_id— GET /setup/v1/businessusers/{id} — Get User
Inputs
clientId/clientSecret— your onsched-setup OAuth app credentialsscope— OAuth scopes (optional; defaults from the spec)operation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: get_setup_v1_appointments
clientId: <your client id>
clientSecret: <your client secret>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | — | OAuth client ID for onsched-setup. |
clientSecret |
string | yes | — | OAuth client secret for onsched-setup. |
operation |
string | yes | — | One of: get_setup_v1_appointments, get_setup_v1_appointments_id, get_setup_v1_businessusers, get_setup_v1_businessusers_permissions, get_setup_v1_businessusers_email_companies, get_setup_v1_businessusers_id |
scope |
string | no | OnSchedApi distance |
OAuth scopes (space-separated); default from the spec. |
email |
string | no | — | Path parameter email (required by some operations). |
id |
string | no | — | Path parameter id (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |