Direct REST API
Move REST calls to v2
Update the base URL, send X-Api-Key, replace retired integration paths, and use the v2 document, export, and webhook actions.
Base URL
Use https://api.crove.app/api/external/v2. The old /api/external/v1/* surface redirects with 308, but integrations should call v2 directly.
- https://api.crove.app/api/external/v1/documents+ https://api.crove.app/api/external/v2/documents
Auth
Send X-Api-Key: <key> on every request. Crove API keys are unscoped; one valid key works for templates, documents, send, export, and webhooks.
curl https://api.crove.app/api/external/v2/me \
-H "X-Api-Key: <key>"Retired paths
| Legacy | Status | v2 equivalent | What changed |
|---|---|---|---|
| /api/integrations/external/* | 410 Gone | /api/external/v2/* | The old integration surface is retired with no compatibility shim. API reference |
| /api/integrations/template-webhooks/* | 410 Gone | /api/external/v2/webhooks* | Webhook registration moved to the v2 webhooks endpoints. API reference |
| /api/external/v1/* | 308 -> v2 | /api/external/v2/* | The redirect works, but clients should repoint directly to v2. API reference |
| /api/integrations/esahayak/documents/create/ | Live | No migration | This eSahayak endpoint is still live and unchanged. API reference |
/api/external/v2/*
The old integration surface is retired with no compatibility shim.
/api/integrations/template-webhooks/*
/api/external/v2/webhooks*
Webhook registration moved to the v2 webhooks endpoints.
/api/external/v2/*
The redirect works, but clients should repoint directly to v2.
Common task calls
For create, update, send, submit, export, list, and webhook setup examples, use the cookbook.
Open recipes →Errors
| Error | Meaning | Fix |
|---|---|---|
| 410 | The legacy integration API was retired on 19 June 2026. There is no shim. | Change the base path to /api/external/v2. |
| 403-quota | The workspace plan does not include the API or WEBHOOKS entitlement. | Confirm the workspace has API access. |
| 308 | v1 redirects to v2, but your integration should not depend on redirects. | Update the configured base URL to /api/external/v2. |
| 401 | The request is missing a valid Crove API key. | Send X-Api-Key: <key> on every request. |
The legacy integration API was retired on 19 June 2026. There is no shim.
Change the base path to /api/external/v2.
The workspace plan does not include the API or WEBHOOKS entitlement.
Confirm the workspace has API access.
v1 redirects to v2, but your integration should not depend on redirects.
Update the configured base URL to /api/external/v2.