List automations

get

https://api.qfp.quantnetwork.net/api/automations

Returns a paginated list of automations. All query parameters are optional, and an empty page is returned (not 404) when nothing matches.

Every status is included, soft-deleted (DELETED) automations among them. Filter by status=ACTIVE for the automations that can fire.

Each automation reports the script version it runs — scriptName, rootScriptId, scriptVersionNumber and scriptStatus — so automations bound to different versions of the same script can be told apart in one call, and one bound to a superseded version shows scriptStatus: OUTDATED.

Filter by rootScriptId for the automations of every version of a script; filter by scriptId for one exact version's.

Pagination matches GET /api/automations/{automationId}/history: page is zero-based, size defaults to 20 within [1, 100], and sort takes field[,asc|desc], defaulting to createdAt,desc.

Query Params

status

string

enum

Filter by automation lifecycle status. An automation is ACTIVE when created, INACTIVE or DISABLED after a status change, and DELETED once removed.

triggerType

string

enum

Filter by trigger type.

Allowed:

scriptId

uuid

Filter by the bound PayScript ID — one exact script version.

rootScriptId

uuid

Filter by script lineage: matches the automations bound to any version of the script chain whose first version has this id, superseded versions included. An id that is not a chain's first version matches nothing.

userId

uuid

Filter by the automation's owner — the userId stamped when it was created.

page

integer

Defaults to 0

Zero-based page number; must not be negative.

size

integer

≤ 100

Defaults to 20

Page size, default 20. A value above 100 returns 100; a value below 1 returns 1.

sort

string

Defaults to createdAt,desc

Sort field and direction as field[,asc|desc] (e.g. createdAt,desc); the direction defaults to desc. The field must be a sortable property, and the direction asc or desc.

Headers

API-Version

string

^\d+\.\d+\.\d+$

Version of the API contract the client targets, in MAJOR.MINOR.PATCH format. Mandated by the Gateway standard. Not yet enforced: requests without the header, or with an unsupported value, are currently processed normally. Once enforcement is enabled, such requests will be rejected with 400 Bad Request.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated list of automations.