Workflow

Retrieve workflow

Changed on

Get a workflow object.

get/api/v1/workflows/{workflowID}

Request

Response

OK

idinteger required

ID of the workflow

namestring required

Name of the workflow

urlstring uri required

URL of the workflow

organizationstring uri required

Organization URL.

conditionobject required

Condition that designates whether the workflow will be entered

Example response

{
  "id": 7540,
  "name": "Approval workflow for US entity",
  "url": "https://example.rossum.app/api/v1/workflows/7540",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "condition": {}
}

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