Open Connector
Custom integration API

Custom integration API

Register customer-owned services, inspect their identities, and suspend or retire integrations.

Register customer-owned services, inspect their identities, and suspend or retire integrations.

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 integrations

GET/api/v1/connector/organizations/{organization_id}/integrations
Scope
integrations:read
Auth
Bearer API key

Lists customer-owned registrations visible to the principal.

Query parameters
limitintegeroptional

Number of records; bounds are inclusive.

default50rule1–200
cursorstringoptional

Opaque continuation; preserve the original filters.

200Result

Returns a data array of Integration records, pagination.next_cursor, and request_id.

Register an integration

POST/api/v1/connector/organizations/{organization_id}/integrations
Scope
integrations:write
Auth
Bearer API key
Repeat calls
Organization-scoped Idempotency-Key; 24 hours

Creates an enabled registration without connection grants or API keys.

Requires Idempotency-Key.

Registration requires Connector Administrator authority or a delegated registration grant. Create keys through service-account access. A registration is not a native product approval.

Request body
namestringrequired

Integration display name.

rule1–120 characters
descriptionstringoptional

Purpose of this integration.

default""ruleAt most 1000 characters
homepage_urlstringrequired

HTTPS location of the integration owner or application.

owner_team_idstringrequired

Responsible team in the owning Solarius organization.

rule1–200 characters
201Created

Returns data as Integration, plus request_id.

Read an integration

GET/api/v1/connector/organizations/{organization_id}/integrations/{integration_id}
Scope
integrations:read
Auth
Bearer API key

Returns registration metadata, enabled state, and revision.

200Result

Returns data as Integration, plus request_id.

Update an integration

PATCH/api/v1/connector/organizations/{organization_id}/integrations/{integration_id}
Scope
integrations:write
Auth
Bearer API key

Updates metadata or suspends the integration identity.

Requires If-Match from a current read.

Omitted fields retain their values. An empty update returns 422 empty_update. Disabling blocks subsequent exchanges and custom record writes; existing copies and native operations remain. Re-enable and synchronize before resuming the consumer.

Request body
namestringoptional

Replacement display name.

rule1–120 characters
descriptionstringoptional

Replacement purpose; empty clears the description.

ruleAt most 1000 characters
enabledbooleanoptional

true permits authorized exchange; false blocks subsequent exchange without deleting copies.

200Result

Returns data as Integration, plus request_id.

Delete an integration

DELETE/api/v1/connector/organizations/{organization_id}/integrations/{integration_id}
Scope
integrations:write
Auth
Bearer API key

Deletes a disabled registration after its dependencies are removed.

Requires If-Match from a current read.

Enabled registrations, retained external records, or connection references return 409 integration_in_use. Retire connections and records first; revoke its service-account keys separately.

204Removed

Returns no body.