Annotation31

Annotation Content9

Audit Log1

Automation Blocker2

Configuration Changelog1

Connector6

Dedicated Engine7

Dedicated Engine Schema8

Delete Recommendation6

Document7

Document Relation6

Documents Download3

Email7

Email Template7

Email Thread4

Engine9

Engine Field7

Generic Engine2

Generic Engine Schema2

Hook12

Hook Run3

Hook Template2

Inbox6

Integration Credential2

Label7

Membership6

Organization11

Organization Group14

Page2

Queue15

Relation6

Rule6

Rules Execution Log1

Saved View6

Schema8

Suggested Edit6

Task1

Trigger6

Upload3

User13

User Role2

Workflow2

Workflow Activity2

Workflow Run3

Workflow Step2

Workspace6

Workflow Step

Retrieve workflow step

Changed on Sep 1, 2026

Get a workflow step object.

get/api/v1/workflow_steps/{workflowStepID}

Request

Base URL
https://example.rossum.app
Auth
HTTP bearer
TypeScript
https://skmtc.dev/rossum/apis/rossum-api/docs/api/v1/workflow_steps/:workflowStepID/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workflowStepIDinteger required

A unique integer value identifying this workflow step.

Response

idinteger required

ID of the workflow step

namestring required

Name of the workflow step

urlstring uri required

URL of the workflow step

organizationstring uri required

Organization URL.

workflowstring uri required

URL of the workflow

conditionobject required

Condition that designates whether the workflow step will be entered

type'approval' required

Type of the workflow step (currently the only supported value is approval)

mode'any' | 'all' | 'auto' required

Supported values:

any - approval of one assignee is enough
all - all assignees must approve
auto - automatically approved if the condition matches

orderinginteger required

Designates the evaluation order of steps within a workflow (must be unique per a workflow)

Example response

{
  "id": 7540,
  "name": "Team Lead approval step",
  "url": "https://example.rossum.app/api/v1/workflow_steps/7540",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "workflow": "https://example.rossum.app/api/v1/workflows/7540",
  "condition": {},
  "type": "approval",
  "mode": "all",
  "ordering": 1
}

Changes

Sep 1, 2026f1b5a910991d Revision changes
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status

Operation history