API Reference

Base URL

https://api.coop.example.com/api/v1

Authentication

All requests require an Authorization header with either an API key or JWT token.

Authorization: Bearer YOUR_API_KEY

See Generate and use API keys for setup instructions.

Rate limits

Exceeding the limit returns 429 Too Many Requests with a Retry-After header (seconds).

Pagination

List endpoints accept page and limit query parameters.

GET /api/v1/contacts?page=2&limit=25

Responses include pagination metadata:

{
  "data": [],
  "pagination": {
    "page": 2,
    "limit": 25,
    "total": 142,
    "totalPages": 6
  }
}

Default limit is 20. Maximum is 100.

Error format

{
  "error": "not_found",
  "message": "Message not found",
  "statusCode": 404
}

Message statuses

Webhook events

Endpoints