integrations

Get an integration

Get an integration by its ID.

get/integration/{integration_id}/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/integration/{integration_id}/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

integration_idstring uuid required

Response

Successful Response

connect_method'oauth_connect' | 'credentials_form'

How a user connects an integration in the UI.

Extensible: as app listings gain non-OAuth connect flows (e.g. install-bound URL secret, per-install signature), add members here rather than another boolean.

An integration type can advertise more than one of these (see IntegrationTypeRead.connect_methods); a specific connection records the single method it was created with on IntegrationModel.connect_method.

created_atstring date-time required
created_by_actor_type'user' | 'api' | 'system' required

Who authorised an action.

created_by_display_namestring nullable

Display name of the creator. User's full name or 'API - {key name}'.

health_checked_atstring date-time nullable

When the latest health check was performed.

health_error_codestring nullable

Machine-readable error code from the latest health check (e.g. 'unauthorized', 'insufficient_permissions', 'rate_limited'). Drives the 'Action required: reauthorize' state and Reconnect CTA when it is 'unauthorized' or 'insufficient_permissions'. Null if never checked or healthy.

health_error_messagestring nullable

Error message from the latest health check, if unhealthy.

health_status'healthy' | 'warning' | 'error'
idstring uuid required
integration_typestring required

The type of the integration.

kind'source' | 'destination' | 'both' required

Query filter: source-only, destination-only, or both.

namestring required

The name of the integration as defined by the user.

org_idstring required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.