Skip to main content

​
Welcome

Welcome to the Enginy API Reference. This section documents the public Enginy API surface, its authentication model, and the supported endpoint groups for external integrations. The API reference includes endpoint groups for campaigns, tasks, contacts, companies, actions, webhooks, and inbox operations.
The interactive Endpoints section is generated from https://openapi.enginy.ai/definitions.json. It reflects the public routes registered in the separate openapi service, not every internal Enginy route.

API Dashboard

Create an API Key or view call logs

​
Authentication

All API endpoints require authentication using an API key. Your API key must be included in the request header x-api-key for every API call.

​
API Key Format

API keys follow a standardized format and begin with the prefix gsk_. You can generate and manage your API keys through the api dashboard. 
x-api-key: gsk_your_api_key_here

​
API Key Management

API Keys can be managed through the API Dashboard. Keys can be revoked or assigned/removed scopes.

​
Scopes and Permissions

API keys are assigned specific scopes that determine their access level and permissions. Each key must have at least one scope to function properly.
API keys without assigned scopes will not have any permissions and all requests will be denied.

​
Available Scopes

Grants full access to all API endpoints and operations. This scope provides unrestricted access to your account resources.
Provides read-only access to identity-related endpoints. Keys with this scope can retrieve identity data but cannot create, update, or delete records.
Allows campaign mutations such as creating campaign drafts, adding contacts to campaigns, cloning campaigns, and changing campaign status.
Allows reading CRM owners for task assignment workflows through GET /v1/tasks/owners.
For security best practices, we recommend using the most restrictive scope necessary for your use case. Avoid using the ALL scope unless your integration requires full account access.
Each endpoint description includes its exact required scope. Use those per-endpoint requirements for the source of truth when composing least-privilege API keys.