Skip to main content
GET
Retrieve a single automation
Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel.

Authorizations

Authorization
string
header
required

Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the "Authorization: Bearer " header.

Path Parameters

account_id
string<ksuid>
required

The ID of the account

Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

id
string<ksuid>
required

The ID of the automation

Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

Response

200 - */*

A single automation object

id
string<ksuid>
Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

name
string
Example:

"XYZ Onramp"

status
enum<string>

The current lifecycle state of the automation.

Available options:
pending,
active,
disabled,
archived
Example:

"active"

source
AutomationSource · object

The funding source for the automation. Defines the fiat rail and value type that the automation accepts. When the automation becomes active, funding_instructions is populated with the virtual account details to share with the payer.

destination
AutomationDestination · object

The destination wallet that receives minted stablecoins when the automation is funded.

created_at
string<date-time>
Example:

"2024-01-15T12:34:56Z"

updated_at
string<date-time>
Example:

"2024-01-15T12:34:56Z"

brand
AutomationBrand · object

Optional. Selects the verified identity shown as the beneficiary on the automation's funding instructions. Pass the account_id of your own account or a managed account (business or individual). The automation is still created under the account in the request path; brand.account_id only controls the identity rendered on the funding instructions. If omitted, Brale is the default beneficiary.