Skip to main content
The Causeloop REST API gives you programmatic access to every resource in the platform — issues, patterns, predictions, recommendations, connectors, and more. All resources live inside a workspace, and every authenticated request is automatically scoped to your workspace.

​
Base URLs

EnvironmentBase URL
Productionhttps://api.causeloop.ai
Local developmenthttp://localhost:4000
All REST endpoints are prefixed with /v1. A request to list issues is GET https://api.causeloop.ai/v1/issues.

​
Versioning

The current API version is v1, expressed as a URL path prefix (/v1/…). Breaking changes will be released under a new prefix (e.g. /v2/…) with a migration guide and a deprecation period. Non-breaking additions — new fields, new optional query parameters, new event types — are made to the current version without a version bump.

​
Content type

All request and response bodies are JSON. Set the Content-Type header on mutating requests: 
Content-Type: application/json
Responses always include Content-Type: application/json.

​
Interactive API explorer

Causeloop ships an interactive OpenAPI explorer at:
EnvironmentURL
Productionhttps://api.causeloop.ai/docs
Localhttp://localhost:4000/docs
The raw OpenAPI schema is available at /openapi.json. You can import it into Postman, Insomnia, or any OpenAPI-compatible client.

​
Authentication overview

Every API request must carry a Bearer JWT in the Authorization header: 
Authorization: Bearer <token>
The typical flow for human users is:
  1. Authenticate with Clerk in your frontend.
  2. Exchange the Clerk session JWT for a Causeloop Bearer token at POST /v1/auth/exchange.
  3. Send the Causeloop token in the Authorization header.
Machine-to-machine callers use service accounts with long-lived tokens instead. See the full Authentication guide for details, including service accounts, MFA, SSO, and SCIM provisioning.

​
How the endpoint reference is organized

The auto-generated reference pages, linked in the sidebar, are organized by resource:

Issues

Create, list, retrieve, update, and close issues. The primary unit of failure.

Patterns

Clusters of related issues. Filter by status, risk score, and domain.

Predictions

Forward-looking alerts generated from active patterns.

Recommendations

Concrete fix recommendations linked to patterns and predictions.

Connectors

Data source connections — create, configure, test, and sync.

Reports

Async report generation and export jobs.

Users & Members

Workspace membership, roles, invitations.

Service Accounts

Machine identities for automation and integrations.

​
Your first request

Once you have a token (see Authentication), list your workspace’s issues: 
curl https://api.causeloop.ai/v1/issues \
  -H "Authorization: Bearer <token>"
You’ll get back a paginated response: 
{
  "data": [...],
  "page": {
    "next_cursor": "eyJvZmZzZXQiOiAyNX0",
    "has_more": true,
    "total": 142
  }
}
Ready to go deeper? Follow the Quickstart to get a token and make your first three calls in under five minutes.