Slate
API Reference

Authentication

API key authentication, scopes, and rate limiting.

All external API endpoints require API key authentication and live under /v1/ext/.

Creating an API key

  1. Go to Settings → Company Settings → API Keys
  2. Click "Create API Key"
  3. Name your key (e.g., "Zapier Integration", "Internal Script")
  4. Copy the key. It is only displayed once and cannot be retrieved later.

Using your API key

Include the key in the x-api-key header with every request:

curl -H "x-api-key: YOUR_API_KEY" \
     https://slate.zerulean.com/v1/ext/items

Scopes

Each API key has scopes that control what it can access:

items:readList and get items
items:writeCreate and update items
tasks:readList and get tasks
tasks:writeCreate and update tasks
hooks:manageSubscribe/unsubscribe REST hooks

New keys are created with all scopes by default.

Rate limits

  • 60 requests per minute per API key
  • Exceeding the limit returns 429 Too Many Requests
  • The rate limit window is 60 seconds

Errors

401Invalid or missing API key
402Company subscription inactive. API access requires an active subscription.
403Key lacks required scope
429Rate limit exceeded

Key management

  • Rename keys to keep track of what they are used for
  • Revoke keys immediately when no longer needed
  • Keys can have optional expiration dates