Authentication - Getting Started - PlanDocket Documentation

API Keys

Authentication is done via API keys. To create a key:

There are three ways to pass your API key:

curl -X GET "https://your-tenant.plandocket.com/api/v1/events" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -X GET "https://your-tenant.plandocket.com/api/v1/events" \
  -H "X-API-Key: YOUR_API_KEY"

curl -X GET "https://your-tenant.plandocket.com/api/v1/events?api_key=YOUR_API_KEY"

This method is not recommended as the key may appear in logs.

API keys can be restricted to specific scopes:

Scope	Access
`events`	Read and write events
`contacts`	Read and write contacts
`participants`	Read and write participants
`applications`	Read and manage applications
`categories`	Read and write categories
`invoices`	Read and write invoices
`payments`	Read and record payments
`tasks`	Read and write tasks
`documents`	Read and generate documents
`submissions`	Read and manage submissions
`booths`	Read and write booths and reservations
`checkins`	Read and create check-ins
`services`	Read services
`service_orders`	Read service orders
`newsletter`	Manage newsletter subscribers
`custom_fields`	Read and write custom fields
`plans`	Read floor plans
`schedules`	Read schedules
`webhooks`	Manage webhooks
`reports`	Retrieve reports
`audit`	Read audit log
`calendar-feed`	Read calendar feed