List all workflows

Retrieves a list of workflows with optional filtering and pagination

Authorization

Authorization<token>

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

In: header

Query Parameters

limitnumber

Number of items to return per page

offsetnumber

Number of items to skip before starting to return results

orderDirectionstring

Direction of sorting

Value in: "ASC" | "DESC"

orderBystring

Field to sort the results by

Value in: "createdAt" | "updatedAt" | "name" | "lastTriggeredAt"

querystring

Search query to filter workflows

tagsarray<string>

Filter workflows by tags

statusarray<string>

Filter workflows by status

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

workflowsRequiredarray<object>

List of workflows

totalCountRequirednumber

Total number of workflows

export interface Response {
  /**
   * List of workflows
   */
  workflows: WorkflowListResponseDto[];
  /**
   * Total number of workflows
   */
  totalCount: number;
}
export interface WorkflowListResponseDto {
  /**
   * Name of the workflow
   */
  name: string;
  /**
   * Tags associated with the workflow
   */
  tags?: string[];
  /**
   * Last updated timestamp
   */
  updatedAt: string;
  /**
   * Creation timestamp
   */
  createdAt: string;
  /**
   * Unique database identifier
   */
  _id: string;
  /**
   * Workflow identifier
   */
  workflowId: string;
  /**
   * Workflow slug
   */
  slug: string;
  /**
   * Status of the workflow
   */
  status: "ACTIVE" | "INACTIVE" | "ERROR";
  /**
   * Origin of the workflow
   */
  origin: "novu-cloud" | "novu-cloud-v1" | "external";
  /**
   * Timestamp of the last workflow trigger
   */
  lastTriggeredAt?: string | null;
  /**
   * Overview of step types in the workflow
   */
  stepTypeOverviews: ("in_app" | "email" | "sms" | "chat" | "push" | "digest" | "trigger" | "delay" | "custom")[];
}

curl -X GET "https://api.novu.co/v2/workflows?limit=0&offset=0&orderDirection=ASC&orderBy=createdAt&query=string&tags=string&status=ACTIVE" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"

{
  "workflows": [
    {
      "name": "string",
      "tags": [
        "string"
      ],
      "updatedAt": "string",
      "createdAt": "string",
      "_id": "string",
      "workflowId": "string",
      "slug": "string",
      "status": "ACTIVE",
      "origin": "novu-cloud",
      "lastTriggeredAt": "string",
      "stepTypeOverviews": [
        "in_app"
      ]
    }
  ],
  "totalCount": 0
}

Authorization

Query Parameters

Header Parameters

Response Body

On this page