Authentication

All Zeeg API endpoints require authentication via a Bearer token sent in the Authorization header.

Generating a Token

Create an API token from your Zeeg dashboard: Account Settings > API When creating a token, you select the specific scopes it should have access to. Follow the principle of least privilege — only grant the scopes your integration actually needs.

Making Authenticated Requests

Include your token in the Authorization header of every request. Every response is JSON, whatever Accept header you send.

curl -X GET https://api.zeeg.me/v2/scheduled-events \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

import requests

response = requests.get(
    "https://api.zeeg.me/v2/scheduled-events",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
    },
)

const response = await fetch("https://api.zeeg.me/v2/scheduled-events", {
  headers: {
    Authorization: "Bearer YOUR_TOKEN",
    Accept: "application/json",
  },
});

If the token is missing or invalid, the API returns a 401 Unauthorized response.

Token Scopes

Each token is scoped to specific permissions. The table below lists all available scopes and the endpoints they unlock.

Scope	Description	Endpoints
`events:read`	Read scheduled events	List events, get event details, get reschedule availability
`events:write`	Change scheduled events	Cancel event, cancel invitee, hand over event, reschedule event
`event_types:read`	Read scheduling pages	List scheduling pages, get scheduling page, get single-use link
`event_types:write`	Change scheduling pages	Toggle scheduling page status, create single-use link
`schedules:read`	Read availability	List schedules, get schedule by UUID, get default schedule, list time-off periods, list holiday categories and subscriptions
`schedules:write`	Change availability	Update schedules, create, update, and delete time-off periods, manage holiday subscriptions
`timetable`	Access availability and time slot data	Get available time slots
`booking`	Create events programmatically	Create an event via the API
`webhooks:read`	Read webhook subscriptions	List webhooks, get webhook details
`webhooks:write`	Create, test, and delete webhooks	Create webhook, test webhook, delete webhook
`users:read`	List workspace users	List users in a workspace
`teams:write`	Add team members	Add a team member to a workspace
`outbound-calls:write`	Trigger AI agent calls	Create outbound call
`agents:read`	View AI agents, their calls, transcripts and collected data	List AI agents, list an agent’s calls, get a call with its transcript and collected data
`notes:read`	Read notes on scheduled events	List notes by event, get note details
`notes:write`	Create, update, and delete notes	Create note, update note, delete note
`routing_forms:read`	Read routing forms	List and get routing forms, list and get submissions
`routing_forms:write`	Change routing forms	Create, update, and delete routing forms, delete submissions
`crm:read`	Read CRM data	List and get objects, people, companies, and records
`crm:write`	Change CRM data	Create, update, upsert, and delete objects, attributes, people, companies, and records
`admin:full`	Full organization access	Required for org-wide operations (e.g., listing all workspace events)

The timetable and booking scopes require a paid Zeeg subscription. If your plan does not include API access to availability slots or programmatic booking, requests using these scopes will be rejected.

Scope Requirements by Endpoint Group

Endpoint Group	Required Scope
Scheduled Events (read, reschedule availability)	`events:read`
Scheduled Events (cancel/handover/reschedule)	`events:write`
Scheduling Pages (list/get)	`event_types:read`
Scheduling Pages (toggle status, single-use link)	`event_types:write`
Available Time Slots	`timetable`
Create an Event	`booking`
Availability, Time-Off, Holidays (read)	`schedules:read`
Availability, Time-Off, Holidays (change)	`schedules:write`
Webhooks (read)	`webhooks:read`
Webhooks (create/delete)	`webhooks:write`
Workspace Users	`users:read`
Add Team Member	`teams:write`
AI Agent Outbound Call	`outbound-calls:write`
AI Agents (read)	`agents:read`
Notes (read)	`notes:read`
Notes (create/update/delete)	`notes:write`
Routing Forms and Submissions (read)	`routing_forms:read`
Routing Forms and Submissions (change)	`routing_forms:write`
CRM (read)	`crm:read`
CRM (change)	`crm:write`
Organization-wide Operations	`admin:full`

Keep your API tokens secure. Treat them like passwords. Do not commit tokens to version control, expose them in client-side code, or share them in plain text. If a token is compromised, revoke it immediately from the API settings page and generate a new one.

Getting Started

Core Concepts

AI Apps & CLI

Generating a Token

Making Authenticated Requests

Token Scopes

Scope Requirements by Endpoint Group

​Generating a Token

​Making Authenticated Requests

​Token Scopes

​Scope Requirements by Endpoint Group

Generating a Token

Making Authenticated Requests

Token Scopes

Scope Requirements by Endpoint Group