Everything the interface does, the API does. REST for records and runs, GraphQL for one query across several objects, webhooks for events, and a Python SDK for scripts and custom transformations.
| Surface | What it is for | Example |
|---|---|---|
| REST API | Read and write records, start runs, read reports, manage connections. | GET /v2/runs/{id}/report |
| GraphQL | One query across several objects for a board or a dashboard. | six REST calls became one GraphQL query on the showcase estate: 3.8 s to 1.2 s |
| Webhooks | Receive events: run finished, check tripped, exception assigned, write confirmed. | POST to your endpoint with a signed payload |
| Python SDK | Scripts, custom transformations, a partner integration. | a partner integrated in 3.5 hours on the showcase estate |
Users sign in through your identity provider (SAML 2.0) and are provisioned by SCIM. API consumers use scoped keys, one per consumer, or OAuth; a key carries the roles and attributes of the consumer, so the access policy applies to API results as it does to screens.
| Consumer (showcase estate) | Limit | Cache |
|---|---|---|
| Partner portal | 100 requests a minute | 5 minutes |
| Operations dashboard | 500 requests a minute | 1 minute |
| Finance BI | 50 requests a minute | 15 minutes |
| Public data portal | 10 requests a minute | 5 minutes |
Endpoint paths, payloads and the SDK reference are in the product documentation behind sign-in; the showcase estate made 8,434 API calls a month at 0.84 s average.
