Documentation Index
Fetch the complete documentation index at: https://octanist.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Base URL
All endpoints are relative to this base URL.
All responses use a consistent envelope format.
Success Response
{
"success": true,
"data": [...],
"meta": {
"pagination": {
"limit": 50,
"page": 1,
"totalPages": 5,
"total": 234,
"hasMore": true
},
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-03-10T12:00:00.000Z"
}
}
Error Response
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Human readable error message",
"details": {}
},
"meta": {
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-03-10T12:00:00.000Z"
}
}
Error Codes
| Code | Description |
|---|
UNAUTHORIZED | Missing or invalid API key |
VALIDATION_ERROR | Invalid request parameters or body |
NOT_FOUND | Resource not found |
FORBIDDEN | Action is not allowed |
CONFLICT | Resource conflict (e.g., duplicates) |
INVALID_DATE | Invalid date format |
INVALID_FILTER | Invalid filter parameter |
INTERNAL_ERROR | Server error |
All list endpoints support pagination using limit and page parameters.
| Parameter | Type | Default | Max | Description |
|---|
limit | number | 50 | 100 (500 for ad-spend) | Results per page |
page | number | 1 | - | Page number (1-indexed) |
{
"meta": {
"pagination": {
"limit": 50,
"page": 2,
"totalPages": 5,
"total": 234,
"hasMore": true
}
}
}
Iterating Through Pages
# Page 1
curl "https://octanist.com/api/leads?limit=50&page=1"
# Page 2
curl "https://octanist.com/api/leads?limit=50&page=2"
# Continue while hasMore is true
Rate Limiting
Currently, there are no rate limits on the API. This may change in the future.
Changelog
| Version | Date | Changes |
|---|
| 1.1.0 | 2026-03 | Added POST /api/leads and PATCH /api/leads docs, fixed source values |
| 1.0.0 | 2024-01 | Initial API release |