API reference
20 operations in integrations. Raw spec: openapi.json.
GET
/api/v1/api-keysGET /api/api-keys — listing without secrets.
Responses
| Status | Description |
|---|---|
200 |
Security: bearer
POST
/api/v1/api-keysPOST /api/api-keys — creates a key and returns the raw secret ONCE.
Request body
CreateApiKeyRequest
Responses
| Status | Description |
|---|---|
201 |
Security: bearer
DELETE
/api/v1/api-keys/{id}DELETE /api/api-keys/{id} — immediate revocation (rotation story: create replacement → revoke old).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Responses
| Status | Description |
|---|---|
204 |
Security: bearer
POST
/api/v1/catalog/pricing-feedsPOST /api/v1/catalog/pricing-feeds — upload one immutable distributor feed batch; admin/owner; then `/{batch_id}/apply` overlays pricing by lowercase SKU.
Request body
PricingFeedBatchRequest
Responses
| Status | Description |
|---|---|
200 | |
422 |
Security: bearer
POST
/api/v1/catalog/pricing-feeds/{batch_id}/applyPOST /api/v1/catalog/pricing-feeds/{batch_id}/apply
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
batch_id | path | string | Yes |
Responses
| Status | Description |
|---|---|
200 | |
404 | |
409 |
Security: bearer
GET
/api/v1/connectorsGET /api/v1/connectors — the org's installed bridges (presence only).
Responses
| Status | Description |
|---|---|
200 |
Security: bearer
POST
/api/v1/connectors/voip/call-logsPOST /api/v1/connectors/voip/call-logs — machine ingest of one call record (idempotent per provider call id). Requires the consents + the `calls.ingest` scope.
Request body
VoipCallLogRequest
Responses
| Status | Description |
|---|---|
200 | |
404 | |
409 |
Security: bearer
POST
/api/v1/connectors/{kind}POST /api/v1/connectors/{kind} — the admin installs / re-consents.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
kind | path | string | Yes |
Request body
ConnectorInstallRequest
Responses
| Status | Description |
|---|---|
200 | |
422 |
Security: bearer
DELETE
/api/v1/connectors/{kind}DELETE /api/v1/connectors/{kind} — withdraws the consent.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
kind | path | string | Yes |
Responses
| Status | Description |
|---|---|
200 | |
404 |
Security: bearer
POST
/api/v1/connectors/{kind}/testPOST /api/v1/connectors/{kind}/test — a provisioned canary through the adapter (slack/teams notifications; rewst trigger).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
kind | path | string | Yes |
Responses
| Status | Description |
|---|---|
200 | |
404 |
Security: bearer
GET
/api/v1/orgs/{org_id}/service-accountsGET /orgs/{org_id}/service-accounts — admin listing with derived cert status.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_id | path | string | Yes |
Responses
| Status | Description |
|---|---|
200 |
Security: bearer
POST
/api/v1/orgs/{org_id}/service-accountsPOST /orgs/{org_id}/service-accounts — enroll a service account by pinning a certificate fingerprint with permission grants and an optional expiry.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_id | path | string | Yes |
Request body
CreateServiceAccountRequest
Responses
| Status | Description |
|---|---|
201 |
Security: bearer
PATCH
/api/v1/orgs/{org_id}/service-accounts/{id}PATCH /orgs/{org_id}/service-accounts/{id} — update grants, expiry, or lifecycle status. The pinned fingerprint and org binding are immutable (a re-pin is a create + revoke).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_id | path | string | Yes | |
id | path | string | Yes |
Request body
UpdateServiceAccountRequest
Responses
| Status | Description |
|---|---|
200 |
Security: bearer
DELETE
/api/v1/orgs/{org_id}/service-accounts/{id}DELETE /orgs/{org_id}/service-accounts/{id} — immediate, permanent revocation. Idempotent: a second delete of an already-revoked account stays successful (the row is present in-scope), so the surface is safe to retry.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_id | path | string | Yes | |
id | path | string | Yes | |
reason | query | string | No |
Responses
| Status | Description |
|---|---|
204 |
Security: bearer
GET
/api/v1/webhooksGET /api/webhooks — the org's subscriptions (never includes secrets).
Responses
| Status | Description |
|---|---|
200 |
Security: bearer
POST
/api/v1/webhooksPOST /api/webhooks — create a subscription; responds with the signing secret once. Emits an audit record in the same transaction.
Request body
CreateWebhookRequest
Responses
| Status | Description |
|---|---|
201 |
Security: bearer
PATCH
/api/v1/webhooks/{id}PATCH /api/webhooks/{id} — mutate URL / filter / enabled flag.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Request body
UpdateWebhookRequest
Responses
| Status | Description |
|---|---|
200 |
Security: bearer
DELETE
/api/v1/webhooks/{id}DELETE /api/webhooks/{id} — removes the subscription; deliveries cascade (history is intentionally scoped to the subscription's life).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Responses
| Status | Description |
|---|---|
204 |
Security: bearer
GET
/api/v1/webhooks/{id}/deliveriesGET /api/webhooks/{id}/deliveries — the in-app delivery log, newest first, keyset-cursor paged.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | |
cursor | query | — | No | |
limit | query | integer | No |
Responses
| Status | Description |
|---|---|
200 |
Security: bearer
POST
/api/v1/webhooks/{id}/testPOST /api/webhooks/{id}/test — fires one `webhook.test` envelope into the real pipeline (outbox → relay → stream → signed delivery), then returns 202; poll the deliveries endpoint to watch attempts land.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Responses
| Status | Description |
|---|---|
202 |
Security: bearer