API Keys

Generate and manage API keys for programmatic access to FormWork.

API keys allow you to access FormWork programmatically through the REST API. Use them to integrate FormWork with your applications, automate tasks, or build custom solutions.

Creating an API Key

1. Go to Account Settings
2. Click the API Keys tab
3. Click Create API Key
4. Enter a name for the key (e.g., “Production Server”)
5. Click Create

Important: Copy your API key immediately after creation. For security reasons, the full key is only shown once.

API Key Format

API keys are prefixed with fwk_ followed by a unique identifier:

fwk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

Using API Keys

In HTTP Headers

Include your API key in the Authorization header:

curl -H "Authorization: Bearer fwk_your_api_key" \
  https://api.formwork.io/api/v1/forms

Authentication Scope

API keys have full access to:

• All forms in the account
• All entries and submissions
• All data tables
• Form management operations

API keys cannot:

• Manage users or permissions
• Access billing information
• Create or delete API keys

Managing API Keys

Viewing Keys

The API Keys tab shows:

• Key name
• Created date
• Last used date
• Partial key (last 4 characters)

Revoking a Key

If a key is compromised or no longer needed:

1. Go to API Keys
2. Find the key to revoke
3. Click Revoke
4. Confirm the action

Warning: Revoking a key immediately invalidates it. Any applications using the key will lose access.

Security Best Practices

Key Management

• Name keys descriptively - Indicate where/how each key is used
• Use separate keys - Create different keys for different applications
• Rotate regularly - Replace keys periodically as a security practice
• Revoke unused keys - Remove keys that are no longer needed

Protecting Keys

• Never commit to version control - Use environment variables instead
• Restrict access - Only share keys with those who need them
• Use HTTPS - Always use encrypted connections
• Monitor usage - Check “last used” dates for unexpected activity

Environment Variables

Store API keys in environment variables:

# .env file (don't commit this!)
FORMWORK_API_KEY=fwk_your_api_key

// Node.js example
const apiKey = process.env.FORMWORK_API_KEY;

Rate Limits

API requests are rate limited to ensure fair usage:

When you exceed a limit:

• API returns 429 Too Many Requests
• Retry-After header indicates when to retry
• Implement exponential backoff in your code

API Endpoints

The FormWork API is available at:

https://api.formwork.io/api/v1/

See the REST API Overview for available endpoints.