Skip to main content
GET
/
{space_id}
/
workflows
/
{workflow_id}
/
jobs
Error
A valid request URL is required to generate request examples
{
  "workflow_jobs": [
    {
      "id": [
        "e75e68e192e6fc04ea3940d302d7bec5"
      ],
      "name": [
        "Sample Workflow Job Name"
      ],
      "workflow_id": [
        "e3c908ad-dc8f-4edb-88f7-c84dec0aef99"
      ],
      "workflow_name": [
        "MyWorkflow"
      ],
      "progress": [
        90
      ],
      "state": [
        "in-process",
        "succeeded",
        "failed"
      ],
      "workflow_version": "<string>",
      "created_at": [
        "2020-01-21T15:53:12.388317Z"
      ],
      "updated_at": [
        "2020-01-22T15:53:12.182617Z"
      ],
      "elapsed_time": [
        "136.08:01:23.5",
        "1:23:45"
      ]
    }
  ],
  "page": [
    1
  ],
  "per_page": [
    30
  ],
  "page_count": [
    27
  ],
  "total_count": [
    1024
  ]
}

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header

Path Parameters

space_id
string<uuid>
required

UP Space Id

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

workflow_id
string<uuid>
required

Unique identifier of a Workflow

Example:

"e3c908ad-dc8f-4edb-88f7-c84dec0aef99"

Query Parameters

page
integer
default:1

Page

per_page
integer
default:30

Number of entries per page

status
enum<string>

Filter WorkflowJobs by status

Available options:
in-process,
completed,
created
query
string

Filter jobs by query

Response

List Workflow Jobs

workflow_jobs
object[]

List of Workflow Jobs for current page

page
integer

Number of current page

Example:
[1]
per_page
integer

Quantity of Workflow Jobs to show on one page

Example:
[30]
page_count
integer

Total number of pages

Example:
[27]
total_count
integer

Total number of Workflow Jobs

Example:
[1024]