curl --request GET \
--url https://api.citadel.example/api/v1/workflows \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.citadel.example/api/v1/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.citadel.example/api/v1/workflows"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.citadel.example/api/v1/workflows"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"id": "0199a3e0-5c6d-7e7f-8091-a2b3c4d5e6f7",
"name": "Deposit sweep",
"event": null,
"inputs": [],
"version": 4,
"published_at": "2026-10-01T09:00:00Z"
},
{
"id": "0199a3e0-6d7e-7f80-91a2-b3c4d5e6f708",
"name": "Payout",
"event": "payout",
"inputs": [
{
"key": "to",
"type": "address",
"required": true
},
{
"key": "amount",
"type": "amount",
"required": true
},
{
"key": "asset",
"type": "asset",
"required": true
},
{
"key": "memo",
"type": "string",
"required": false
}
],
"version": 2,
"published_at": "2026-10-05T14:30:00Z"
}
]
}List workflows
The active, published workflows on one network, by name. For a workflow your backend
starts, event is the name POST /events/{name} takes and inputs what it declares: each
input’s key, type and whether it is required. A workflow Citadel starts itself (on a
deposit, on a schedule) or another workflow calls has event: null and no inputs. name
is what GET /runs filters on.
An input’s type is what POST /events/{name} checks its value against: wallet one of
your active wallets on the network (reference, id or address), asset an asset credited
there (symbol or contract), address a TRON address, amount a base-unit integer,
number an integer, decimal a decimal number, boolean true or false, string
anything.
network is required. Needs the read scope. A key limited to vaults is refused with
403 vault_limited, like the event door.
curl --request GET \
--url https://api.citadel.example/api/v1/workflows \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.citadel.example/api/v1/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.citadel.example/api/v1/workflows"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.citadel.example/api/v1/workflows"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"id": "0199a3e0-5c6d-7e7f-8091-a2b3c4d5e6f7",
"name": "Deposit sweep",
"event": null,
"inputs": [],
"version": 4,
"published_at": "2026-10-01T09:00:00Z"
},
{
"id": "0199a3e0-6d7e-7f80-91a2-b3c4d5e6f708",
"name": "Payout",
"event": "payout",
"inputs": [
{
"key": "to",
"type": "address",
"required": true
},
{
"key": "amount",
"type": "amount",
"required": true
},
{
"key": "asset",
"type": "asset",
"required": true
},
{
"key": "memo",
"type": "string",
"required": false
}
],
"version": 2,
"published_at": "2026-10-05T14:30:00Z"
}
]
}Authorizations
An API key minted in the console (ctd_…). Authenticates; never authorizes funds. A key
carries scopes (read, wallets.write, transactions.write, events.write,
webhooks.write, policy.write) and may be limited to vaults, to IP addresses, and in
lifetime — see Authentication.
Query Parameters
The network the data lives on. Required — there is no default network: without it,
422 network_required. A wallet named by its id on another network: 422 network_mismatch.
The network the data lives on. Required wherever it appears in a request — there is no
default network. One your installation does not serve: 422 network_not_served.
mainnet, testnet Response
The workflows.
Show child attributes
Show child attributes