Skip to main content
GET
Get an account

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

Query Parameters

expand
string | null

A comma-separated list of additional fields to expand. Supported values: connector (the connector display data), connector_profile (the connector profile id and label), last_request, and actions (the connector action catalog, each flagged with whether it is enabled for this account's connector profile). These are omitted (returned as null) unless requested, as resolving them is more expensive.

Example:

"connector,connector_profile,last_request,actions"

Response

The account was retrieved.

id
string
required

The unique identifier of the account.

connector_key
string
required

The connector/provider key this account connects to (e.g. workday). Always present; the full connector object requires ?expand=connector.

status
enum<string>
required

The current status of the account.

Available options:
active,
inactive,
suspended,
archived,
expired,
error
status_reasons
object[]
required

Reasons explaining the current status.

owner_id
string
required

The account owner's identifier in the provider's system.

name
string
required

The account owner's name in the provider's system.

type
string
required

The account type (e.g. production or test).

created_at
string<date-time>
required

When the account was created.

updated_at
string<date-time>
required

When the account was last updated.

connected_at
string<date-time> | null
required

When the account was connected to its integration; null if unknown.

expires_at
string<date-time> | null
required

When the account expires (test accounts only); null for production.

connector
object | null

The connector this account uses. Only present when requested via ?expand=connector.

connector_profile_id
string | null

The identifier of the connector profile this account is linked to. Only present when requested via ?expand=connector_profile.

connector_profile_label
string | null

The connector profile label: the connector profile name, appended with the authentication label (e.g. Acme | Production). Only present when requested via ?expand=connector_profile.

last_request
string<date-time> | null

When the account last made a request. Only present when requested via ?expand=last_request.

actions
object[] | null

The account's connector action catalog, each flagged with whether it is enabled for the connector profile. Only present when requested via ?expand=actions.

owner_username
string | null

The end-user identifier within the owner, if any.