Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.schedkit.net/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
1. Get an API key

Sign up at schedkit.net and grab your API key from the dashboard under Kit Config → API Keys. 
export SCHEDKIT_KEY=sk_live_...

​
2. Check your profile

curl https://schedkit.net/v1/auth/me \
  -H "x-api-key: $SCHEDKIT_KEY"

{
  "id": 42,
  "email": "you@example.com",
  "name": "Your Name",
  "plan": "starter"
}

​
3. Send your first signal

curl -X POST https://schedkit.net/v1/signals \
  -H "x-api-key: $SCHEDKIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "note",
    "note": "First signal. Online."
  }'

{
  "Id": 1,
  "type": "note",
  "note": "First signal. Online.",
  "user_id": 42,
  "created_at": "2026-03-15T05:00:00Z"
}

​
4. Watch the stream

Open a second terminal and subscribe to your org’s live signal feed: 
curl -N https://schedkit.net/v1/signals/stream \
  -H "x-api-key: $SCHEDKIT_KEY"

data: {"type":"connected","org_ids":[3]}

data: {"type":"signal.note","payload":{"Id":1,"note":"First signal. Online.",...}}

​
5. Create a booking

curl -X POST https://schedkit.net/v1/bookings \
  -H "x-api-key: $SCHEDKIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type_id": 1,
    "attendee_name": "Jason Johnson",
    "attendee_email": "jason@example.com",
    "start_time": "2026-03-20T14:00:00Z"
  }'

​
Next steps

Signals API

Full signal types, org scoping, SSE stream.

Beacon Mode

GPS pings, field captures, and alert signals from mobile.

Incidents

Create tickets with SLA timers and threaded replies.

Webhooks

Receive events in your own system on every booking or signal.