Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.xoxo.email/llms.txt

Use this file to discover all available pages before exploring further.

​
Base URL

https://api.xoxo.email
All endpoints are versioned under /v1.

​
Authentication

The API authenticates requests with bearer tokens. Get one in Settings → Apps, then include it on every request: 
curl https://api.xoxo.email/v1/account \
  -H "Authorization: Bearer YOUR_API_KEY"
Treat API keys like passwords. Never commit them to source control or expose them in client-side code.

​
Pagination

List endpoints return a data array alongside a meta object: 
{
  "data": [ ... ],
  "meta": {
    "current_page": 1,
    "last_page": 4,
    "per_page": 25,
    "total": 92
  }
}
Use the page and per_page query parameters to walk through results.

​
Errors

The API uses conventional HTTP status codes.
CodeMeaning
200Success
201Created
204Success, no content
400Invalid request
401Missing or invalid API key
404Resource not found
422Validation failed
429Rate limit exceeded
5xxServer error
Error responses include a JSON body describing what went wrong.

​
Rate limits

Requests are rate limited per API key. When you exceed the limit, the API responds with 429 Too Many Requests. Back off and retry after a short delay.