List workflows

GET

/workflows

curl --request GET \
  --url 'https://safe-api.safetyradar.com/v2/workflows?flowType=assessment&q=Safety&page=1&limit=50' \
  --header 'Authorization: Bearer <token>' \
  --header 'x-team: my-team-slug'

• Production

List all active workflow definitions for a team. Only returns the active version of each workflow.

Authorizations

• Bearer

Parameters

Query Parameters

flowType

Filter by flow type (e.g., ‘assessment’, ‘form_submission’)

string

Example

assessment

Filter by flow type (e.g., ‘assessment’, ‘form_submission’)

q

Search workflows by name

string

Example

Safety

Search workflows by name

page

Page number (default: 1)

integer

default: 1

Example

1

Page number (default: 1)

limit

Results per page (default: 50, max: 1000)

integer

default: 50 <= 1000

Example

50

Results per page (default: 50, max: 1000)

Header Parameters

x-team

Deprecated — accepted but ignored; the v2 API is org-scoped.

string

Example

my-team-slug

Deprecated — accepted but ignored; the v2 API is org-scoped.

Responses

200

List of workflows

Media typeapplication/json

object

data

required

Array<object>

object

id

required

string format: uuid

organizationId

required

string format: uuid

teamId

required

string format: uuid

nullable

flowType

required

string

name

required

string

version

required

integer

>= -2147483648 <= 2147483647

isActive

required

boolean

createdById

required

string format: uuid

nullable

createdAt

required

string

updatedAt

required

string

meta

required

object

pagination

required

object

page

required

number

limit

required

number

total

required

number

totalPages

required

number

hasNext

required

boolean

hasPrev

required

boolean

Example^generated

{
  "data": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "teamId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "flowType": "example",
      "name": "example",
      "version": 1,
      "isActive": true,
      "createdById": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "createdAt": "example",
      "updatedAt": "example"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 1,
      "total": 1,
      "totalPages": 1,
      "hasNext": true,
      "hasPrev": true
    }
  }
}

401

Unauthorized

Media typeapplication/json

object

code

required

string

message

required

string

details

object

key

additional properties

nullable

Example^generated

{
  "code": "example",
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}