Skip to main content
GET
Get connector action

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).

actionId
string
required

The id of the action (e.g. hibob_list_employees).

Query Parameters

version
string | null

The connector version to read the action from, overriding any version in the id. Accepts latest. Resolved automatically when omitted.

owner
string | null

The owner of the connector version, overriding any owner in the id. Accepts the wildcards builtin (global) and custom (the organization's own). Resolved automatically when omitted.

expand
string | null

A comma-separated list of additional fields to expand. Supported values: steps (the sequence the action runs to fulfil a call) and result (how the response body is built from it). Both are null unless requested.

Response

The action was retrieved.

id
string
required

The unique id of the action.

label
string
required

The display label of the action.

description
string
required

The description of the action.

action_type
enum<string> | null
required

The operation the action performs on the resource.

Available options:
list,
get,
create,
update,
delete,
custom,
refresh_token,
test,
event,
unknown
schema_type
enum<string> | null
required

Whether the action speaks the provider's own schema or a unified one.

Available options:
native,
unified
schema
string | null
required

The unified schema the action reads or writes (e.g. employees). null for native actions.

details
string | null
required

Extended documentation for the action, as Markdown.

categories
string[]
required

The categories the action belongs to.

resources
string | null
required

A link to the provider's documentation for the underlying operation.

effects
enum<string>[]
required

The effects the action has on the external system.

The effects the action has on the external system.

Available options:
read,
write,
delete,
search,
execute
required_scopes
string[]
required

The provider scopes the action requires under every authentication method. Empty when it scopes per method instead — read authentication[].required_scopes.

release_stage
enum<string> | null
required

The release stage of the action.

Available options:
preview,
beta,
ga,
deprecated,
internal
tags
string[]
required

The tags of the action.

authentication
object[]
required

The authentication methods the action can be run under, with the scopes each needs.

syncable
boolean
required

Whether the data-sync engine can sync this action.

inputs
object[]
required

The inputs the action accepts, in declaration order. Object inputs nest theirs under properties; rules spanning inputs are in validation_rules.

validation_rules
object[]
required

Rules spanning several inputs, which the per-input required flag cannot express. Apply these too, or a call can still be rejected.

steps
object | null
required

The sequence the action runs to fulfil a call, keyed by step id. null unless requested with expand=steps.

result
required

How the response is built: a response field to expression mapping, or a single expression for the whole body. null unless requested with expand=result. A mapping referring back to its own ancestor reads as [cyclic].