List workflows for the current org

GET

/api/v1/workflows/list

const url = 'https://api.yggy.tech/api/v1/workflows/list?state=all&page=1&pageSize=20';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.yggy.tech/api/v1/workflows/list?state=all&page=1&pageSize=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
apiKeyAuth

Parameters

Query Parameters

state

string

default: all

Allowed values: all active completed failed

page

number

default: 1 >= 1

pageSize

number

default: 20 >= 1 <= 100

Header Parameters

host

string | null

x-yggy-organization-id

string | null

Responses

200

Workflow list

application/json

object

workflows

required

Array<object>

object

documentId

required

string

title

required

string

invocationId

required

string | null

status

required

string | null

Allowed values: pending scheduled ready running paused backing-off suspended completed failed cancelled

step

required

string | null

progress

required

number

createdAt

required

string

updatedAt

required

string

ownerId

required

string | null

workflowType

string

default: extraction

Allowed values: extraction purge

isCancellable

boolean

total

required

number

page

required

number

pageSize

required

number

totalPages

required

number

state

required

string

Allowed values: all active completed failed

Example

{
  "workflows": [
    {
      "status": "pending",
      "workflowType": "extraction",
      "isCancellable": false
    }
  ],
  "state": "all"
}