Cirrus API

Developer documentation

Docs

API Documentation

Integrate with the Cirrus API to query and modify your integration. All endpoints are HTTPS and return JSON by default.

Base URL https://api.cirrusreader.com

Authentication

This API requires authentication. Include your API key in the Authorization header of every request.

Authorization: Bearer YOUR_API_KEY 
curl -X GET "https://api.cirrusreader.com/v1/users" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Common Errors

Common error responses.

401

Unauthorized

Invalid or missing API key.

403

Forbidden

Incorrect privileges to access this endpoint or method

405

Method Not Supported

The HTTP method used is not supported on this endpoint

429

Too Many Requests

Rate limit exceeded. Try again later.