Get workflows

GET 
/workflows

Get a listing of workflows; available as an Add-On Module

Request

Query Parameters

siteId string

Site Identifier

next string

Next page of results token

limit string
Limit Results
Default value: 10
status string

Possible values: [ACTIVE, INACTIVE]

Filters Status

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

next string

Next page of results token

workflows

object[]

List of workflows

Array [

name string

Name of Workflow

workflowId string

Workflow identifier

description string

Description of Workflow

insertedDate string

Inserted Timestamp

userId string

User who created workflow

inUse boolean

Whether the Workflow is in use

status WorkflowStatus (string)

Status of the Workflow

Possible values: [ACTIVE, INACTIVE]

]

Example (from schema)

{
  "next": "string",
  "workflows": [
    {
      "name": "string",
      "workflowId": "string",
      "description": "string",
      "insertedDate": "string",
      "userId": "string",
      "inUse": true,
      "status": "ACTIVE"
    }
  ]
}

Loading...