REST API Overview

The DataRecs REST API provides full programmatic access to the platform.

Base URL

https://api.datarecs.com/v1

Authentication

All requests require a Bearer token in the Authorization header:

curl -H "Authorization: Bearer $DATARECS_API_KEY" \
  https://api.datarecs.com/v1/workspaces

API keys are scoped to a workspace and can be created in the Console or via Terraform.

Common endpoints

Method	Path	Description
GET	/workspaces	List all workspaces
POST	/workspaces	Create a workspace
GET	/connections	List connections in current workspace
POST	/connections	Create a connection
GET	/jobs	List reconciliation jobs
POST	/jobs	Create a job
POST	/jobs/:id/run	Trigger a job run
GET	/jobs/:id/runs	List run history for a job
GET	/jobs/:id/runs/:runId	Get run results

Error format

{
  "statusCode": 400,
  "message": "Validation failed",
  "errors": [
    { "field": "name", "message": "name is required" }
  ]
}

Rate limiting

API requests are rate-limited to 100 requests per minute per API key. The response includes X-RateLimit-Remaining and X-RateLimit-Reset headers.