Skip to main content
GET
Get a connector profile

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The unique identifier of the connector profile.

Query Parameters

expand
string | null

A comma-separated list of additional fields to expand. Supported values: connector (the connector this profile configures), version (the connector version this profile resolves to), accounts_count (the number of accounts linked to this profile) and enabled_actions_count (how many of that version's actions this profile enables). These are returned as null unless requested.

Example:

"connector,version"

Response

The connector profile was retrieved.

id
string
required

The unique identifier of the connector profile.

name
string
required

The display name of the connector profile.

connector_key
string
required

The connector key (e.g. workday). Always present; the full connector object requires ?expand=connector.

connector
object | null
required

The connector this profile configures. Always present; null unless requested via ?expand=connector.

version
object | null
required

The connector version this profile resolves to. Always present; null unless requested via ?expand=version.

accounts_count
integer | null
required

The number of accounts linked to this connector profile that are visible to you. Always present; null unless requested via ?expand=accounts_count.

enabled_actions_count
integer | null
required

How many of the connector version's actions this profile enables. For StackOne connectors only the actions in the release stages your organization can access are counted, so this can read lower than the number the profile actually enables; a connector your organization owns is counted in full. A profile that enables everything counts all of them; one naming individual actions counts only those the version still has. 0 when the profile enables nothing, and also whenever no catalogue can be resolved — an unreadable registry, or a connector whose own release stage your organization cannot access. Always present; null unless requested via ?expand=enabled_actions_count on a read endpoint, and always null on create.

active
boolean
required

Whether the connector profile is active.

default
boolean
required

Whether this is the default connector profile.

environment
string | null
required

The environment of the connector profile.

authentication_config_key
string | null
required

The authentication configuration key.

created_at
string<date-time>
required

The timestamp when the connector profile was created.

updated_at
string<date-time>
required

The timestamp when the connector profile was last updated.

setup_fields
object
required

The saved non-secret setup field values, keyed by setup field key.

secrets
object
required

The saved secret fields, keyed by field key. Values are __secretvalue:-prefixed redacted placeholders (never the plaintext); resend a placeholder unchanged to keep the stored secret.

action_config
object
required

The per-action enablement of the profile, keyed by action id.

event_config
object
required

The per-event-action configuration (enablement and subscribed webhooks), keyed by event action id.

sync_config
object
required

The per-action data-sync configuration, keyed by action id.