Api reference
Endpoints
Complete map of the 20 public REST operations, grouped by resource.
The pages below are generated directly from the OpenAPI contract. Each operation page includes authentication, parameters, examples, request and response schemas, headers, success states, and actionable errors.
Accounts
| Method | Path | Operation |
|---|---|---|
GET | /v1/accounts | List accounts |
Catalogue and Query
| Method | Path | Operation |
|---|---|---|
GET | /v1/catalog | List catalogue |
POST | /v1/sql | Query SQL |
GET | /v1/query-receipts/{receiptId} | Get query receipt |
Sources
| Method | Path | Operation |
|---|---|---|
GET | /v1/connector-definitions | List connector definitions |
POST | /v1/source-authorization-requests | Create authorization request |
GET | /v1/source-authorization-requests/{requestId} | Get authorization request |
GET | /v1/sources | List Sources |
GET | /v1/sources/{sourceId} | Get Source |
DELETE | /v1/sources/{sourceId} | Delete Source |
POST | /v1/sources/{sourceId}/run | Run Source |
POST | /v1/sources/{sourceId}/authorization-requests | Request Source authorization |
POST | /v1/sources/{sourceId}/pause | Pause Source |
POST | /v1/sources/{sourceId}/resume | Resume Source |
POST | /v1/schema-reviews/{reviewId} | Decide schema review |
Activity
| Method | Path | Operation |
|---|---|---|
GET | /v1/activity | List Activity |
GET | /v1/activity/{eventId} | Get Activity event |
Access
| Method | Path | Operation |
|---|---|---|
GET | /v1/grants | List grants |
POST | /v1/grants | Create grant |
DELETE | /v1/grants/{grantId} | Revoke grant |
Download the complete machine-readable contract from platform.trycombined.com/openapi.json. Internal browser, webhook, job, Desktop-enrollment, and service routes are intentionally excluded from this public surface.