Prerequisites
Before you begin, you need:- Access to an Instantly workspace.
- A tool that can send HTTP requests. This guide uses cURL.
1
Create an API key
Open Settings > Integrations > API Keys and create an API v2 key.Select the scopes your integration needs. Copy the key when Instantly displays it because you cannot view it again.
2
Send your first request
List up to five email accounts in your workspace:Replace
YOUR_API_KEY with the key you created. A successful request returns a JSON response containing the accounts your key can access.3
Handle errors
Check the HTTP status code before processing the response:
401means the API key is missing or invalid.403means the API key does not have the required scope.429means the workspace exceeded an API rate limit.
Next steps
Authorization
Learn how bearer authentication works.
Rate limits
Keep your integration within workspace limits.
API reference
Browse available endpoints and schemas.
Integration guides
Follow detailed guides for OAuth, webhooks, and workspace groups.