Onsched Consumer

OnSched Consumer is an appointment scheduling API for letting customers search availability and book appointments.

• 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/token using your clientId/clientSecret, then calls the API.

Operations

• get_consumer_v1_appointments — GET /consumer/v1/appointments — Get Appointments
• get_consumer_v1_appointments_bookingfields — GET /consumer/v1/appointments/bookingfields — Get Custom Fields Labels
• get_consumer_v1_appointments_customfields — GET /consumer/v1/appointments/customfields — Get Custom Fields List
• get_consumer_v1_appointments_id — GET /consumer/v1/appointments/{id} — Get Appointment
• get_consumer_v1_availability_serviceid_startdate — GET /consumer/v1/availability/{serviceId}/{startDate}/{endDate} — Get Available Times
• get_consumer_v1_customers — GET /consumer/v1/customers — List Customers

Inputs

• clientId / clientSecret — your onsched-consumer OAuth app credentials
• scope — 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 params
• body — JSON object for create/update ops

Example

operation: get_consumer_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.

• error
• operation
• result
• status

Input Properties

Every property this tool accepts, from its own tool.iml.