Connection API
Create, inspect, activate, pause, resume, revoke, and remove relationships between product and custom endpoints.
Create, inspect, activate, pause, resume, revoke, and remove relationships between product and custom endpoints.
Use the shared request contract for authentication, pagination, preconditions, idempotency, and common errors. Exact response members are defined in API data types and the downloadable OpenAPI contract.
List connections
/api/v1/connector/organizations/{organization_id}/connectionsLists connections visible to the principal.
limitintegeroptionalNumber of records; bounds are inclusive.
50rule1–200cursorstringoptionalOpaque continuation; preserve the original filters.
Returns a data array of Connection records, pagination.next_cursor, and request_id.
Create a connection
/api/v1/connector/organizations/{organization_id}/connectionsCreates a draft relationship with immutable endpoint identities.
Requires Idempotency-Key.
Both endpoints must belong to the owning organization. Unsupported Status endpoints return 422 product_unavailable. Creation grants no exchange; add and approve directional grants.
namestringrequiredDisplay name; renaming preserves identity.
endpointsEndpoint[]requiredExactly one a endpoint and one b endpoint; identities are immutable.
Returns data as Connection, plus request_id.
Read a connection
/api/v1/connector/organizations/{organization_id}/connections/{connection_id}Returns participant identities, the active grant generation, health, and synchronization time.
Returns data as Connection, plus request_id.
Activate a connection
/api/v1/connector/organizations/{organization_id}/connections/{connection_id}/activateActivates a draft connection and its approved grants.
Requires If-Match from a current read. Requires Idempotency-Key.
Poll the returned operation, then read the connection. Activation requires both endpoint approvals for every selected grant.
Pause and revocation do not cancel accepted native product work. Invalid lifecycle transitions return 409 invalid_state.
reasonstringrequiredAudited reason; empty values are rejected.
Returns operation.id for operation polling and request_id; acceptance does not establish completion.
Pause a connection
/api/v1/connector/organizations/{organization_id}/connections/{connection_id}/pauseStops subsequent exchange after the operation acknowledges Paused.
Requires If-Match from a current read. Requires Idempotency-Key.
Poll the returned operation, then read the connection. Activation requires both endpoint approvals for every selected grant.
Pause and revocation do not cancel accepted native product work. Invalid lifecycle transitions return 409 invalid_state.
reasonstringrequiredAudited reason; empty values are rejected.
Returns operation.id for operation polling and request_id; acceptance does not establish completion.
Resume a connection
/api/v1/connector/organizations/{organization_id}/connections/{connection_id}/resumeRechecks active grants and refreshes permitted present state.
Requires If-Match from a current read. Requires Idempotency-Key.
Poll the returned operation, then read the connection. Activation requires both endpoint approvals for every selected grant.
Pause and revocation do not cancel accepted native product work. Invalid lifecycle transitions return 409 invalid_state.
reasonstringrequiredAudited reason; empty values are rejected.
Returns operation.id for operation polling and request_id; acceptance does not establish completion.
Revoke a connection
/api/v1/connector/organizations/{organization_id}/connections/{connection_id}/revokeRevokes subsequent exchange and all connection grants; fresh approval is required to reconnect.
Requires If-Match from a current read. Requires Idempotency-Key.
Poll the returned operation, then read the connection. Activation requires both endpoint approvals for every selected grant.
Pause and revocation do not cancel accepted native product work. Invalid lifecycle transitions return 409 invalid_state.
reasonstringrequiredAudited reason; empty values are rejected.
Returns operation.id for operation polling and request_id; acceptance does not establish completion.
Delete a connection
/api/v1/connector/organizations/{organization_id}/connections/{connection_id}Deletes a revoked connection after its transport dependencies are resolved.
Requires If-Match from a current read.
Active grants or unresolved deliveries return 409 connection_in_use. Resolve the listed dependencies; use native product retirement for hosted capacity or protected routes.
Returns no body.