Get connector
Returns the details of a single connector, including its description, documentation URL and authentication methods.
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The connector id, in the form key[@version][~owner] (e.g. hibob@1.2.0~stackone).
Query Parameters
The connector version to fetch. Overrides any version embedded in the id. Accepts latest to resolve the latest version. When omitted, the version is resolved automatically.
The owner of the connector version. Overrides any owner embedded in the id. Accepts the wildcards builtin (the global stackone owner) and custom (the organization's own connectors). When omitted, the owner is resolved automatically.
The id of a connector profile to report the actions against. Every action returned by expand=actions then carries enabled, the actions the profile enables are listed first, and enabled_actions_count reports how many of them it enables. Requires expand=actions; supplying it without that is a 400. Omit it to receive the connector as configured for no profile.
A comma-separated list of additional fields to expand. Supported values: actions (the actions and event-actions metadata — a large payload; empty arrays when the connector exposes no actions metadata), versions (the registry versions of the connector, newest first — the version options a connector profile can be pinned to), changelog (the connector's release history, newest first — one entry per published version with its summary, labels, release date and affected actions; StackOne's built-in Falcon connectors only), accounts_count (the number of accounts linked to the connector) and connector_profiles_count (the number of connector profiles configured for the connector). These are expensive to resolve, so they are returned as null unless requested.
"accounts_count,connector_profiles_count"
Response
The connector was retrieved.
The connector key (e.g. workday).
The human-readable connector name (e.g. Workday).
The URL of the connector's logo.
The connector description; null when the connector declares none.
The categories the connector belongs to (e.g. ["hris"]).
One-line summaries of the authentication methods the connector supports.
The connector version.
The owner of the connector.
The release stage of the connector (e.g. ga, beta).
The number of actions the connector exposes to the organization; 0 when the connector does not report action counts.
The number of event actions the connector exposes; 0 when the connector does not report event counts.
The URL of the public StackOne documentation for the connector; null when no public documentation is available.
The authentication methods the connector supports, keyed by authentication config key and then by environment. Contains field definitions, notices and OAuth metadata — never credential values.
The metadata of the actions the connector exposes (id, label, description, tags, required scopes…). Only resolved when expand=actions is requested; null otherwise. When connector_profile_id is supplied, the actions that profile enables come first and every action carries enabled.
How many of the connector's actions the connector profile given in connector_profile_id enables, out of actions_count. Only resolved when connector_profile_id is supplied together with expand=actions; null otherwise.
The metadata of the event actions the connector exposes. Only resolved when expand=actions is requested; null otherwise.
The registry versions of the connector, newest first — the version options a connector profile can be pinned to. Only resolved when expand=versions is requested; null otherwise. Empty for connectors with no registry versions.
The connector's release history: one entry per published version, newest first, with its summary, labels, release date and affected actions. Only resolved when expand=changelog is requested, and only for StackOne's built-in Falcon connectors; null otherwise, including connectors with no published changelog.
The number of accounts linked to the connector in this project. Only resolved when expand=accounts_count is requested; null otherwise.
The number of connector profiles configured for the connector in this project. Only resolved when expand=connector_profiles_count is requested; null otherwise.