API Overview
Integrate Crove into your workflows with the REST API. Create templates, generate documents, and automate your document pipeline.
API Reference
The Crove REST API lets you programmatically create templates, generate documents, send invitations, and retrieve data. Use it to integrate Crove into your existing applications and automate document workflows.
Base URL
All API requests are made to:
https://crove.app/api/external/v1Authentication
All API requests require an API key passed in the Authorization header:
Authorization: Bearer YOUR_API_KEYSee Authentication for details on creating and managing API keys.
Response format
All responses are JSON. Successful responses include the requested data:
{
"data": {
"id": "abc123",
"name": "Sales Contract",
"createdAt": "2026-01-15T10:30:00Z"
}
}Error responses include an error message:
{
"error": {
"code": "NOT_FOUND",
"message": "Template not found"
}
}HTTP status codes
| Code | Description |
|---|---|
200 | Success |
201 | Resource created |
400 | Bad request — invalid parameters |
401 | Unauthorized — missing or invalid API key |
403 | Forbidden — insufficient permissions |
404 | Resource not found |
429 | Rate limit exceeded |
500 | Internal server error |
Available endpoints
Templates
| Method | Endpoint | Description |
|---|---|---|
GET | /templates | List all templates |
POST | /templates | Create a new template |
GET | /templates/{id} | Get template details |
PATCH | /templates/{id} | Update a template |
DELETE | /templates/{id} | Delete a template |
Documents
| Method | Endpoint | Description |
|---|---|---|
GET | /documents | List all documents |
POST | /documents | Create a document from a template |
GET | /documents/{id} | Get document details |
PATCH | /documents/{id} | Update a document |
DELETE | /documents/{id} | Delete a document |
GET | /documents/{id}/pdf | Download document PDF |
POST | /documents/{id}/send | Send invitations |
Rate limits
| Method | Endpoint | Description |
|---|---|---|
GET | /rate-limit | Check current rate limit status |
Quick start example
Create a document from a template and send it for signing:
# 1. Create a document from a template with pre-filled data
curl -X POST https://crove.app/api/external/v1/documents \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"templateId": "tmpl_abc123",
"name": "Contract - Acme Corp",
"data": {
"clientName": "Acme Corporation",
"clientEmail": "john@acme.com",
"contractAmount": 50000,
"startDate": "2026-03-01"
}
}'
# 2. Send the document for signing
curl -X POST https://crove.app/api/external/v1/documents/doc_xyz789/send \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"recipients": [
{
"email": "john@acme.com",
"role": "Client",
"message": "Please review and sign the contract."
}
]
}'
# 3. Download the completed PDF
curl -X GET https://crove.app/api/external/v1/documents/doc_xyz789/pdf \
-H "Authorization: Bearer YOUR_API_KEY" \
-o contract.pdfSDKs and libraries
The Crove API is a standard REST API that works with any HTTP client. You can use:
- cURL — Command-line HTTP client
- JavaScript/Node.js —
fetch,axios, or any HTTP library - Python —
requests,httpx - Ruby —
net/http,httparty - PHP —
cURL,Guzzle
Next steps
- Authentication — Set up API keys
- Templates API — Template endpoints
- Documents API — Document endpoints
- Rate Limits — Usage limits and quotas