Methods

  • get - Get workflows list

Resource

{
    "links": {
        "next": "uri",
        "prev": "uri"
    },
    "results": [
        {
            "activatedAt": "date-time",
            "createdAt": "date-time",
            "description": "string",
            "finalizedAt": "date-time",
            "folder": "string",
            "id": "string",
            "lastPausedAt": "date-time",
            "lastResumedAt": "date-time",
            "name": "string",
            "status": "string",
            "tags": [
                "string"
            ],
            "updatedAt": "date-time"
        }
    ]
}

Properties

Name Type Description Additional
links object

The pagination links

Optional
links.next uri

The next list page url if there are more elements

Optional
links.prev uri

The previous list page url if there is a previous page

results[] array

The workflow list

results[].activatedAt date-time

The date of workflow activation in ISO8601 format

Optional
results[].createdAt date-time

The date of workflow creation in ISO8601 format

results[].description string

The description of the workflow

results[].finalizedAt date-time

The date of workflow finalization in ISO8601 format

Optional
results[].folder string

The folder of the workflow. A workflow can be only inside one folder.

Optional
results[].id string

The identifier of the workflow

results[].lastPausedAt date-time

The date of workflow latest pause in ISO8601 format

Optional
results[].lastResumedAt date-time

The date of workflow latest resume in ISO8601 format

Optional
results[].name string

The name of the workflow

results[].status string

The status of the workflow

Possible values are:

  • draft
  • active
  • paused
  • finalized
  • scheduled
results[].tags[] array of string

The tags of the workflow

results[].updatedAt date-time

The date of workflow latest update in ISO8601 format

Optional