Help Center
Integrations

API

Updated April 24, 2026
39 views

title: API category: Integrations order: 12 description: Programmatic access to SchedulingKit via the REST API with Sanctum tokens.

API

The SchedulingKit REST API lets you programmatically manage event types, events, clients, locations, workflows, invoices, transactions, and taxes.

Authentication

All API requests require a Bearer token in the Authorization header.

Creating an API token

  1. Go to Settings → API Tokens.
  2. Click Create Token.
  3. Enter a name (e.g. "CRM Integration", "Mobile App").
  4. Optionally select permission scopes.
  5. Click Create. The token is shown once — copy it immediately.

Using the token

Include the token in every request:

Authorization: Bearer your-api-token-here

Base URL

https://yourdomain.com/api/v1

Replace yourdomain.com with your app's domain or subdomain.

Endpoints

Team

MethodEndpointDescription
GET/teamGet current team info
PUT/teamUpdate team info

Event Types

MethodEndpointDescription
GET/event-typesList all event types
POST/event-typesCreate an event type
GET/event-types/{id}Get a specific event type
PUT/event-types/{id}Update an event type
DELETE/event-types/{id}Delete an event type

Events

MethodEndpointDescription
GET/eventsList events (supports filters)
POST/eventsCreate an event
GET/events/{id}Get event details
PUT/events/{id}Update an event
DELETE/events/{id}Cancel an event
GET/events/{id}/occurrencesList recurring event occurrences

Clients

MethodEndpointDescription
GET/clientsList clients
POST/clientsCreate a client
GET/clients/{id}Get client details
PUT/clients/{id}Update a client
DELETE/clients/{id}Delete a client

Locations

MethodEndpointDescription
GET/locationsList locations
POST/locationsCreate a location
GET/locations/{id}Get location details
PUT/locations/{id}Update a location
DELETE/locations/{id}Delete a location

Workflows

MethodEndpointDescription
GET/workflowsList workflows
POST/workflowsCreate a workflow
GET/workflows/{id}Get workflow details
PUT/workflows/{id}Update a workflow
DELETE/workflows/{id}Delete a workflow

Invoices

MethodEndpointDescription
GET/invoicesList invoices
POST/invoicesCreate an invoice
GET/invoices/{id}Get invoice details
PUT/invoices/{id}Update an invoice

Transactions

MethodEndpointDescription
GET/transactionsList transactions
GET/transactions/{id}Get transaction details

Taxes

MethodEndpointDescription
GET/taxesList tax rules
POST/taxesCreate a tax rule
GET/taxes/{id}Get tax rule details
PUT/taxes/{id}Update a tax rule
DELETE/taxes/{id}Delete a tax rule

Pagination

List endpoints return paginated results. Use query parameters:

  • page — Page number (default: 1).
  • per_page — Items per page (default: 15, max: 100).

Response includes pagination metadata: current_page, last_page, per_page, total.

Filtering

List endpoints support query filters. Common filters:

  • search — Text search across relevant fields.
  • status — Filter by status.
  • from / to — Date range filters.

Refer to specific endpoint documentation for available filters.

Rate limits

API requests are rate-limited. If you exceed the limit, you'll receive a 429 Too Many Requests response with a Retry-After header.

Errors

StatusMeaning
200Success
201Created
400Bad request (invalid parameters)
401Unauthorized (invalid or missing token)
403Forbidden (insufficient permissions)
404Not found
422Validation error (details in response body)
429Rate limited
500Server error

Error responses include a JSON body with message and optionally errors (for validation).

Managing tokens

  • View tokens — Settings → API Tokens lists all active tokens.
  • Revoke — Click Delete to revoke a token. It stops working immediately.
  • Tokens do not expire unless revoked.