Skip to main content
GET
Get connector

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 connector id, in the form key[@version][~owner] (e.g. hibob@1.2.0~stackone).

Query Parameters

version
string | null

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.

owner
string | null

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.

connector_profile_id
string | null

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.

expand
string | null

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.

Example:

"accounts_count,connector_profiles_count"

Response

The connector was retrieved.

key
string
required

The connector key (e.g. workday).

name
string
required

The human-readable connector name (e.g. Workday).

logo_url
string
required

The URL of the connector's logo.

description
string | null
required

The connector description; null when the connector declares none.

categories
string[]
required

The categories the connector belongs to (e.g. ["hris"]).

authentication_methods
object[]
required

One-line summaries of the authentication methods the connector supports.

version
string
required

The connector version.

owner
string
required

The owner of the connector.

release_stage
string
required

The release stage of the connector (e.g. ga, beta).

actions_count
integer
required

The number of actions the connector exposes to the organization; 0 when the connector does not report action counts.

events_count
integer
required

The number of event actions the connector exposes; 0 when the connector does not report event counts.

documentation_url
string | null
required

The URL of the public StackOne documentation for the connector; null when no public documentation is available.

authentication
object
required

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.

actions
object[] | null
required

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.

enabled_actions_count
integer | null
required

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.

event_actions
object[] | null
required

The metadata of the event actions the connector exposes. Only resolved when expand=actions is requested; null otherwise.

versions
object[] | null
required

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.

changelog
object | null
required

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.

accounts_count
integer | null

The number of accounts linked to the connector in this project. Only resolved when expand=accounts_count is requested; null otherwise.

connector_profiles_count
integer | null

The number of connector profiles configured for the connector in this project. Only resolved when expand=connector_profiles_count is requested; null otherwise.