Authentication

Secure your API requests with API keys

API Keys

API keys are the primary way to authenticate with the CollaBevy API. Each key is tied to your account and can have specific scopes (permissions).

Scopes

When creating an API key, you can select which scopes it should have. This allows you to create keys with limited permissions for specific integrations.

Rate Limits

API requests are rate limited to 60 requests per minute by default. Rate limit headers are included in every response.

API Key Format

API keys follow a predictable format that makes them easy to identify:

sk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  • sk_ - Prefix indicating a secret key
  • live_ - Environment indicator
  • 32 random characters - Unique identifier

Using Your API Key

Include your API key in the Authorization header of every request:

Authorization: Bearer sk_live_your_api_key

Available Scopes

API keys can be created with specific scopes to limit what they can access:

Collaborations

collabs:readView collaborations and their details
collabs:writeCreate and update collaborations

Contracts

contracts:readView contracts and agreements
contracts:writeCreate and update contracts

Invoices

invoices:readView invoices and payment status
invoices:writeCreate and update invoices

Deliverables

deliverables:readView deliverables and submissions
deliverables:writeCreate and update deliverables

Profile

profile:readView creator profile information
profile:writeUpdate creator profile

Portal

portal:readView portal configuration
portal:writeUpdate portal settings

Security Best Practices

Never expose your API key

Don't commit API keys to version control or include them in client-side code.

Use minimal scopes

Only grant the permissions your integration actually needs.

Rotate keys regularly

Periodically rotate your API keys, especially if you suspect they may have been compromised.

Ready to get started?

Create your first API key in your dashboard