How do I get an API key and make my first request?
Short answer
As workspace owner on Pro or Enterprise, open Organization settings, API & webhooks, and click Create key. Choose a name and the scopes (read, write, check-in), copy the key once, and store it on your server. Then call GET https://www.guestlistonline.com/api/v1/me with the header "Authorization: Bearer YOUR_KEY" to confirm it works. Full reference at guestlistonline.com/docs.
Create a key
- Sign in as the owner of the workspace and open Organization settings from the account menu, then the tab API & webhooks.
- Click Create key. Give it a name that says where it is used (Zapier, badge printer, CRM sync).
- Pick the scopes. Read covers everything available today. Write and check-in are for the endpoints in the next release; you can tick them now so the key does not need replacing later.
- Optionally set an expiry date. Save. The key is shown once; copy it and store it in your server's environment variables.
Your first request
curl https://www.guestlistonline.com/api/v1/me \
-H "Authorization: Bearer glo_live_..."
The answer names your workspace, the key and its scopes. From there:
GET /eventslists your events with guest, attending and checked-in counts.GET /events/{id}/guests?status=attendinglists the guests of one event; filter by tag, email or updated_since.- Lists come in pages: pass
next_cursorback as?cursor=until it is null.
Keep the key safe
- A key sees only its own workspace, and only what its scopes allow. Still treat it like a password.
- Never put it in a browser page or a mobile app. The API refuses browser requests on purpose.
- Revoke a key the moment you suspect it leaked; the revocation is immediate. You can have up to 10 active keys, so use one per integration.
Limits and errors
120 requests per minute and 5,000 per hour per key. Every error has a stable code, for example rate_limited, insufficient_scope or plan_required, and a plain message. The Recent API requests list on the same settings tab shows what your integration did and which calls failed.
Questions about this
- Can an admin of my workspace create keys?
- No. Only the owner can create, rename and revoke keys, because a key reaches every event in the workspace.
- Does the API work on the free plan or a per-event upgrade?
- No. It is part of Pro and Enterprise. A key on a workspace without an active subscription gets a 402 error with the code plan_required.
- Can I add guests or check people in through the API?
- Not yet. This release is read-only: events and guests. Creating events and guests, check-in and webhooks are the next release; the docs page lists the roadmap.