ROrossum
Workflow Step

List workflow steps

Changed on

Retrieve all workflow step objects.

get/api/v1/workflow_steps

Request

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

workflowinteger

ID of the workflow to filter workflow steps by

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

Mode of the workflow step to filter by

type'approval'

Type of the workflow step to filter by

ordering'id' | '-id'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "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

  • f1b5a910991dRevision 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