GET `/api/v1/workflow/rules/{id}`

One workflow rule.

Scope workflow:read
operationId workflowRule

The token needs the scope workflow:read, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Request

GET /api/v1/workflow/rules/{id}

Path parameters

Name	Description	Example
`id`	The id of the rule.	`41`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl

curl "https://vestoris.com/api/v1/workflow/rules/41" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/workflow/rules/41",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/workflow/rules/41", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: WorkflowRule. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`id`	id (string)	The record's id (a string of digits).
`lineage_id`	id (string)	The id shared by every version of the rule.
`version`	integer	Version number.
`name`	string	The rule's name.
`item_type`	string	The kind of item: order, override, rule, violation, batch, feed_run, access_review, exception.
`priority`	integer	1 (urgent) to 4 (low); for rules, lower numbers are evaluated first.
`status`	string	draft, pending, active, superseded, retired or rejected.
`state`	string	How the rule stands now (in force, scheduled, waiting for sign-off…).
`is_default`	boolean	True for the default rules that reproduce the firm thresholds.
`conditions`	any	When the rule applies: "all" conditions must hold and at least one "any" condition.
`actions`	list	What the rule does when its conditions hold (approvals, queue, assignment, priority, SLA, notifications).
`restatement`	string	What the engine will enforce, written by code from the structured definition.
`source_text`	string	The words the rule was written from.
`drafted_by_ai`	boolean	True when the AI drafted it (a person still checks and signs).
`pending_action`	string or null	What is waiting for sign-off: "activate", "change" or "retire".
`weakens`	boolean	True when the change weakens an approval (then Compliance must also sign).
`weakens_why`	string	Why it counts as weakening.
`signoffs`	object	Who has signed off so far.
`signoffs.admin`	id (string) or null	The Admin who signed off (id), or null.
`signoffs.compliance`	id (string) or null	The results of the compliance checks (rule, outcome, measured value, limit).
`test_bench`	object or null	The latest test-bench result: what the rule would have blocked, warned on or logged.
`effective_from`	date-time or null	When this version took (or takes) effect.
`effective_to`	date-time or null	When this version stopped being in force (null: still in force).
`created_by`	id (string) or null	The user who created it.
`created_at`	date-time or null	When it was created.
`done`	boolean	Whether every required sign-off is in.
`still_needed`	list of string	Sign-offs still needed.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "1042",
    "lineage_id": "41",
    "version": 1,
    "name": "Large Growth orders",
    "item_type": "order",
    "priority": 2,
    "status": "active",
    "state": "in force",
    "is_default": false,
    "conditions": {
        "all": [
            {
                "field": "notional",
                "op": ">",
                "value": 1000000
            }
        ],
        "any": []
    },
    "actions": [
        {
            "type": "require_approval",
            "roles": [
                "portfolio_manager",
                "compliance_officer"
            ],
            "count": 2
        }
    ],
    "restatement": "Block any order that would make one issuer more than 5.00% of a Growth account (ETFs excepted).",
    "source_text": "",
    "drafted_by_ai": false,
    "pending_action": "",
    "weakens": false,
    "weakens_why": "",
    "signoffs": {
        "admin": null,
        "compliance": []
    },
    "test_bench": null,
    "effective_from": null,
    "effective_to": null,
    "created_by": "7",
    "created_at": "2026-10-27T14:30:00Z",
    "done": false,
    "still_needed": [
        "compliance"
    ]
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

Status	When	Problem codes
200	Success
400	The request is malformed	`invalid_request`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
429	Rate limited: wait for Retry-After seconds	`rate_limited`

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/workflow/rules/41"
}

On the screens

The same thing in the app is explained in:

Workflow rules