Skip to main content

​
Overview

All Firstwork API requests must be authenticated using an API key passed in the Authorization header.

​
API Key Authentication

Include your API key as a Bearer token in the Authorization header of every request:

​
Obtaining an API Key

API keys are generated in the Firstwork dashboard: Go to Settings > API Keys in your Firstwork dashboard.

​
Generate a new key

Click Generate New Key and give it a descriptive name (e.g., “Production Integration”, “Zapier Connector”).

​
Copy your key

Copy the API key immediately — it won’t be shown again.

​
Store securely

Store the key in a secure location such as an environment variable or secrets manager.

​
Company Context

After authentication, all API calls are automatically scoped to the company associated with your API key. This ensures all data access is isolated to your organization — you cannot accidentally access another company’s data.

​
Permissions

API access respects your organization’s permission model:
  • Read permissions control which data can be queried
  • Write permissions control which data can be modified
  • Some endpoints require admin-level API keys