API tokens let your own code, or tools like Zapier and Make, call the Zeeg API as you. You start a token from what it is for, so it gets only the permissions that job needs. Zeeg shows the token once, right after you create it.
You can have up to 5 active tokens at once. Some permissions need a paid plan: Available times, Create bookings and the write level of Users are locked while you are on a trial. If your plan only includes AI minutes, a token can hold only the AI permissions.
How to create an API token
Open Settings, then Connections, then Access Token. If you don't have a token yet, you see the starting points right on this page.
Click Create API token (or click a starting point on the empty page).
Under What is this token for?, choose a starting point and click Next. The panel on the right shows an example of what the token can do and which permissions it gets.
Type a Token name. Zeeg suggests one based on the starting point, and you can change it.
Click the expiry button next to the name and choose 30 days, 90 days, 1 year or Custom. With Custom, pick a day on the calendar. The token expires at the end of that day in your account's time zone.
Check the permissions under Set for this use. Change a level with None, Read or Write if you need to, or open Customize permissions to add others.
Click Create API token.
Under Copy your token, click Copy token and store the token somewhere safe, such as a secret manager. Click Done when you have it.
Zeeg shows the token only this once. If you close the dialog before copying it, Zeeg asks Close without copying?. Click Close anyway only if you are fine creating a new token.
Which starting point should you choose?
Check availability: ask from your own server whether a scheduling page still has a free time. Permissions: Scheduling pages (read) and Available times.
Book from your site: show free times in your own form and book them there. Permissions: Scheduling pages (read), Available times and Create bookings.
Sync bookings: get new and changed bookings into your CRM or data warehouse. Permissions: Bookings (read) and Webhooks (write).
Sync contacts: keep the people and companies in your CRM in step with Zeeg. Permission: CRM records (write).
AI phone agents: let your system ask an AI phone agent to call a lead and read the results. Permissions: Outbound calls (write) and AI phone agents (read).
Custom: pick every permission yourself.
Each permission row shows its API scope name, for example timetable or event_types:read, as the API documentation spells it. In Customize permissions, the search field finds a permission by its label or by its scope name.
You can also switch on Full access instead (scope admin:full). That token can read, change and delete everything you can, so use it only when no starting point fits.
Paid-plan permissions
A starting point or permission your plan doesn't include is marked with a lock and Needs a paid plan, with the plan it needs next to it. You can still look at it, but the dialog ends in Upgrade instead of Next or Create API token. If you can't manage billing, the dialog tells you who can upgrade the plan.
For the details of what happens to tokens when your plan changes, see What happens to your scheduling pages, calendars and API tokens when you downgrade.
Manage your tokens
The token list shows each token's name, its permissions as chips, and when it expires. At the top of the page, next to Create API token, a counter such as 2/5 tokens shows how many of your five tokens are in use.
A token with full access shows a Full access badge.
A token that expires within 14 days shows how many days are left, for example in 3 days.
A token whose expiry date has passed shows an Expired badge. It still counts toward the limit of 5 until you revoke it.
Hover over the expiry date to see the exact time in your account's 12-hour or 24-hour format.
Renew a token
Click More actions on the token's row and choose Renew token. The dialog opens with the same name and permissions, so you only pick a new expiry. Renewing creates a second token beside the first, so you need a free place under the limit of 5.
Revoke a token
Click More actions on the token's row, choose Revoke token, and confirm. The dialog names the token it revokes. Anything that uses it stops working right away, and this can't be undone.
Frequently asked questions
I lost my token. Can I see it again?
No. Zeeg shows a token only once, when you create it. Create a new token (or use Renew token to copy the permissions of the old one), then revoke the lost one.
Why is the Create API token button disabled?
Either you already have 5 active tokens, or your plan doesn't include API access. Revoke a token you no longer need, or upgrade your plan. Tokens that are paused by a plan change don't count toward the 5.
Why can't I choose Write for a permission?
That level needs a paid plan, so it is shown locked. Click Upgrade to see the plans that include it.
My plan only includes AI minutes. What can my token do?
It can hold only the AI permissions: Outbound calls (write) and AI phone agents (read or write). The other permissions are locked and the Full access instead switch is hidden.
Where do I find the API documentation?
The Zeeg developer documentation lists every endpoint and the scope it needs.