You'll need a PlaybookOps account. Any member can make keys, unless an admin has turned the API off for your organization.
- 1
Make a key
Open Account → API keys in PlaybookOps and click New key. Name it after what will use it, like "Zapier" or "Support agent". Then choose:
- Read-only to look around safely. Nothing can be changed with it.
- Full access when your code needs to create or update things.
You can also set it to expire after 30, 90 or 365 days. Copy the key when it's shown. It starts with
pbo_live_, and you won't see it again. Keep it in an environment variable rather than in your code:export PLAYBOOKOPS_API_KEY="pbo_live_…" - 2
Check who you are
GET /v1/metells you who the key belongs to and what it's allowed to do.curl https://developers.playbookops.ai/v1/me \ -H "Authorization: Bearer $PLAYBOOKOPS_API_KEY"You'll get your name, organization and the key's scopes:
{ "id": "4b1c…", "name": "Ana Ruiz", "organization_id": "9f20…", "role": "member", "scopes": ["projects:read", "tasks:read", "knowledge:read", "automations:read", "apps:read", "people:read", "kpis:read"], "via": "api_key" }A
401means the key is wrong, expired or revoked. See errors for the rest. - 3
Read a project
List your projects, then the open items in one of them:
curl "https://developers.playbookops.ai/v1/projects?limit=5" \ -H "Authorization: Bearer $PLAYBOOKOPS_API_KEY" curl "https://developers.playbookops.ai/v1/projects/PROJECT_ID/items?include_completed=false" \ -H "Authorization: Bearer $PLAYBOOKOPS_API_KEY"Everything you can open in the app has a
url, so you can link people straight to it. - 4
Go further
- Follow a guide: projects and items, tasks or knowledge.
- Open the API reference and use Try it on any endpoint. It runs against your own organization, so changes made there are real.
- Connect an AI agent with the same key.
A read-only key can't change anything, so it's safe for exploring, reports and dashboards. Make a separate Full access key for code that needs to write.