NOnovu
Workflows

List all workflows

Changed on

Retrieves a list of workflows with optional filtering and pagination

get/v2/workflows

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

Query parameters

limitnumber
Example:10

Number of items to return per page

offsetnumber

Number of items to skip before starting to return results

orderDirection'ASC' | 'DESC'

Direction of sorting

orderBy'createdAt' | 'updatedAt' | 'name' | 'lastTriggeredAt'

Field to sort the results by

querystring

Search query to filter workflows

tagsstring[]

Filter workflows by tags

statusWorkflowStatusEnum[]

Filter workflows by status

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

totalCountnumber required

Total number of workflows

Changes

  • a5b639d63138Revision changes
    • breaking

      the // response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to object for status

  • b8c9ccc86d6eRevision changes
    • warning

      added the new CHAT_CARD_INVALID_BUTTON enum value to the //////////// response property for the response status

    • warning

      added the new CHAT_CARD_LIMIT_EXCEEDED enum value to the //////////// response property for the response status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status