Skip to main content
GET
/
v2
/
workflows
/
{id}
/
status
Get workflow status
curl --request GET \
  --url https://api.portable.io/v2/workflows/{id}/status \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "lifecycle": "PENDING",
  "disposition": "SUCCEEDED",
  "resources": [
    {
      "name": "<string>",
      "extracted": 123,
      "analyzed": 123,
      "loaded": 123,
      "errors": [
        "<string>"
      ]
    }
  ],
  "errors": [
    "<string>"
  ],
  "completedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer<int>
required

ID

Response

OK

​
id
integer<int>
required

The ID of the workflow

​
lifecycle
enum<string>
required

The lifecycle status of the workflow

Available options:
PENDING,
RUNNING,
NOT_RUNNING
​
disposition
enum<string>
required

The disposition of the workflow

Available options:
SUCCEEDED,
FAILED,
NONE
​
resources
object[]
​
errors
string[]

The errors that occurred during the workflow's execution

​
completedAt
string<date-time>

The timestamp marking when the execution of the workflow was last completed. It will be set to null either if the workflow is actively running or has never been initiated.