Skip to content
LionrapidLionRapid Docs

List Workflows

GET
/api/data/workflows
curl --request GET \
  --url 'https://example.com/api/data/workflows?include_inactive=false'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
include_inactive
Any of:
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Workflows Api Data Workflows Get
Array<object>
WorkflowListItem
object
id
required
Id
integer
key
required
Key
string
name
required
Name
string
description
Any of:
string
is_active
required
Is Active
boolean
stages
required
Stages
Array<object>
WorkflowStageItem
object
id
required
Id
integer
index
required
Index
integer
name
required
Name
string
stage_type_key
Any of:
string
default_role
Any of:
Role
string
Allowed values: project_manager translator proofreader reviewer ocr company admin
Example
[
  {
    "stages": [
      {
        "default_role": "project_manager"
      }
    ]
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}