Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".

Headers

idempotency-key
string

A header for idempotency purposes

Query Parameters

limit
number

Number of items to return per page

offset
number

Number of items to skip before starting to return results

orderDirection
enum<string>

Direction of sorting

Available options:
ASC,
DESC
orderBy
enum<string>

Field to sort the results by

Available options:
createdAt,
updatedAt,
name,
lastTriggeredAt
query
string

Search query to filter workflows

tags
string[]

Filter workflows by tags

status
enum<string>[]

Filter workflows by status

Status of the workflow

Available options:
ACTIVE,
INACTIVE,
ERROR

Response

OK

workflows
object[]
required

List of workflows

totalCount
number
required

Total number of workflows