OnSched Setup API

Name: OnSched Setup API API
Brand: OnSched Setup API
Availability: InStock

✓ Official Vendor SpecProductivityCalendar Schedulingoauth2139 EndpointsREST

For Agents

Configure companies, services, resources, calendars, and business rules that back OnSched booking flows using OAuth 2.0 client-credentials authentication.

Connect the OnSched Setup API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the OnSched Setup API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with OnSched Setup API API.

Provision and update companies and their domains

Manage business users, including their permissions and the companies they belong to

Create, update, and recover calendars, plus list services attached to a calendar

Block out time on a calendar and remove or update those blocks

GET STARTED

Start building with OnSched Setup API API

Explore with Jentic

View OpenAPI Document

OnSched is a developer-first online booking platform. The Setup API exposes the configuration surface that backs every consumer booking flow: companies, business users, calendars, services, resources, locations, blocks, and the rules that determine when a service can be booked. With 139 endpoints, it covers every CRUD operation an admin or platform integrator needs, including reassigning appointments to different resources and recovering soft-deleted calendars. It is paired with the Consumer API that handles end-user booking and the Utility API that handles health checks.

Use Cases

Patterns agents use OnSched Setup API API for, with concrete tasks.

★ Tenant provisioning for a booking platform

A vertical SaaS that sits on top of OnSched needs to provision a new tenant when a customer signs up: create the company, attach domains, configure business users, and stand up the calendars and services. The Setup API covers all of those steps in a single auth domain, so the SaaS can ship signup-to-bookable in a few days. Each provisioning step is idempotent enough to be retried safely.

POST /setup/v1/companies for the new tenant, POST /setup/v1/companies/domains, then POST /setup/v1/calendars and /setup/v1/businessusers as needed.

Calendar and resource administration

Operations admins manage day-to-day changes: blocking time off, adding new staff, retiring services, and reassigning bookings when a resource calls in sick. The Setup API supports each of these directly without requiring a UI round-trip, including PUT /setup/v1/appointments/{id}/reassign/resource/{resourceId} for reassignment and the calendar block CRUD endpoints. Most ops automations are built as scheduled jobs against the API.

POST /setup/v1/calendars/{id}/block to mark out a public holiday, then PUT /setup/v1/appointments/{id}/reassign/resource/{resourceId} for any clashes.

Multi-company franchise rollout

Franchise networks roll out OnSched across many companies that share configuration patterns. The Setup API exposes companies, business users, and the calendars under each, so a rollout script can clone a reference configuration into each new franchisee's company. The /setup/v1/businessusers/{email}/companies lookup makes it easy to attach a regional manager to all the companies they oversee.

Read the reference company's calendars and services, then POST /setup/v1/companies and copy each calendar and service into the new company's profile.

AI agent platform configuration through Jentic

An AI assistant that helps a SaaS admin configure new tenants can call the OnSched Setup API through Jentic. The agent searches Jentic for the configuration operations, loads their schemas, and provisions companies, business users, and calendars. Jentic injects the OAuth credential at execution time so the agent can act across many tenants without holding their secrets.

Search Jentic for 'create onsched company', load the POST /setup/v1/companies operation, and execute it with the new tenant's name and timezone.

Key Endpoints

139 endpoints — onsched is a developer-first online booking platform.

METHOD

PATH

DESCRIPTION

POST

/setup/v1/companies

Create a new company tenant

POST

/setup/v1/companies/domains

Attach a domain to a company

POST

/setup/v1/calendars

Create a calendar under a company

POST

/setup/v1/calendars/{id}/block

Block time on a calendar

PUT

/setup/v1/calendars/{id}/recover

Recover a soft-deleted calendar

POST

/setup/v1/businessusers

Create a business user account

PUT

/setup/v1/appointments/{id}/reassign/resource/{resourceId}

Reassign an appointment to a different resource

POST

/setup/v1/companies

Create a new company tenant

POST

/setup/v1/companies/domains

Attach a domain to a company

POST

/setup/v1/calendars

Create a calendar under a company

POST

/setup/v1/calendars/{id}/block

Block time on a calendar

PUT

/setup/v1/calendars/{id}/recover

Recover a soft-deleted calendar

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The Setup API token is high-trust because it can create companies, business users, and calendars. Storing the OAuth client credentials in the Jentic vault and injecting access tokens at execution time prevents misuse and scopes provisioning agents to the exact tenant.

Intent-based discovery

Agents search Jentic with intents like 'create onsched company' or 'block onsched calendar' and Jentic returns the matching Setup operations with their input schemas, so the agent can run provisioning steps without browsing the OnSched docs.

Time to first call

Direct OnSched Setup integration: 2-3 weeks for OAuth, the company-calendars-services-resources provisioning path, and admin reassignment flows. Through Jentic: under 1 hour to search, load the schema, and provision the first tenant.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

OnSched Consumer API

End-user booking surface that consumes the Setup API's configuration

Use the Consumer API alongside the Setup API once the company, services, and resources are configured and the agent needs to book on behalf of an end user.

Alternative

Calendly API

Hosted scheduling product with simpler configuration than OnSched

Choose Calendly when the team needs a quick hosted scheduling product rather than a deeply configurable platform-style booking backend.

Alternative

Acuity Scheduling API

Service-business scheduling with a lighter admin API

Choose Acuity when the customer is a single small business and does not need OnSched's multi-tenant company and business-user model.

FAQs

Specific to using OnSched Setup API API through Jentic.

What authentication does the OnSched Setup API use?

The Setup API uses OAuth 2.0 client credentials, the same as the Consumer API. Each tenant has a ClientId and Secret bound to its company profile. Through Jentic, the credentials are stored in the vault and the access token is refreshed transparently, so an agent provisioning many tenants never sees raw secrets.

Can I provision a new company end-to-end with this API?

Yes. Start with POST /setup/v1/companies, attach domains via POST /setup/v1/companies/domains, then create the calendars under that company with POST /setup/v1/calendars and seed business users with POST /setup/v1/businessusers. The Setup API covers the full provisioning path in a single auth domain.

How do I block time on a calendar with the OnSched Setup API?

POST /setup/v1/calendars/{id}/block with the start and end times. To list existing blocks, GET /setup/v1/calendars/{id}/blocks. To edit or remove a block, use PUT /setup/v1/calendars/block/{id} or DELETE /setup/v1/calendars/block/{id}. These endpoints back both holiday calendars and ad hoc time-off.

What are the rate limits for the OnSched Setup API?

OnSched does not publish a single global rate limit in the spec. Bulk provisioning scripts should batch reads with the list endpoints, avoid polling for state, and back off on 429 responses. The Setup API has 139 endpoints, so plan for paginated reads and don't try to enumerate every calendar in a tenant in a single call.

How do I reassign an appointment through Jentic?

Install the SDK with 'pip install jentic', search for the operation with the query 'onsched reassign appointment', then load the PUT /setup/v1/appointments/{id}/reassign/resource/{resourceId} operation, and execute it with the appointment id and the new resource id. Jentic handles the OAuth refresh.

Can I recover a calendar that was deleted by mistake?

Yes. PUT /setup/v1/calendars/{id}/recover restores a soft-deleted calendar along with its services attachment. This is the difference between OnSched's setup model and a hard-delete API, and it is the safe path for ops teams that want to undo an accidental change.