---
title: "List Workflow"
method: POST
path: "/workflow/get-list"
tags: ["Workflow"]
---

# List Workflow

`POST /workflow/get-list`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/workflow/get-list`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/workflow/get-list/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to list all Workflow items

## Request body

- object
  - `query` WorkflowQuerySchema: Query schema for Workflow. A field takes a value, which it matches exactly, or an operator its type allows. A relation is filtered by the fields of the record it names, {"<relation>": {"<field>": <value or Search>}}, and a resource with owners by who owns it, {"owners": {"_type": "OwnedBy", "userIds": [...], "teamIds": [...]}}.
    - `_id` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string, uuid
      - object
        - `_type` 'EqualTo', required
        - `value` string, uuid, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, uuid, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, uuid, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `createdAt` union: A filter on a Date field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'EqualTo', required
        - `value` string, date-time, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `updatedAt` union: A filter on a Date field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'EqualTo', required
        - `value` string, date-time, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `deletedAt` union: A filter on a Date field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'EqualTo', required
        - `value` string, date-time, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `projectId` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string, uuid
      - object
        - `_type` 'EqualTo', required
        - `value` string, uuid, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, uuid, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, uuid, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `name` union: A filter on a Text field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes.
      - string
      - object
        - `_type` 'EqualTo', required
        - `value` string, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `slug` union: A filter on a Slug field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string
      - object
        - `_type` 'EqualTo', required
        - `value` string, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `description` union: A filter on a Long Text field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes.
      - string
      - object
        - `_type` 'EqualTo', required
        - `value` string, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `createdByUserId` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string, uuid
      - object
        - `_type` 'EqualTo', required
        - `value` string, uuid, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, uuid, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, uuid, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `deletedByUserId` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string, uuid
      - object
        - `_type` 'EqualTo', required
        - `value` string, uuid, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, uuid, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, uuid, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `isArchived` union: A filter on a Boolean field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull.
      - boolean
      - object
        - `_type` 'EqualTo', required
        - `value` boolean, required
      - object
        - `_type` 'NotEqual', required
        - `value` boolean, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` boolean, required
    - `archivedAt` union: A filter on a Date field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'EqualTo', required
        - `value` string, date-time, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `archivedByUserId` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string, uuid
      - object
        - `_type` 'EqualTo', required
        - `value` string, uuid, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, uuid, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, uuid, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `isEnabled` union: A filter on a Boolean field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull.
      - boolean
      - object
        - `_type` 'EqualTo', required
        - `value` boolean, required
      - object
        - `_type` 'NotEqual', required
        - `value` boolean, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` boolean, required
    - `graph` union: A filter on a JSON field, by key: {"<field>": {"<key>": <value or operator>}}. A key takes a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. IsNull and NotNull on the field itself ask whether it holds anything.
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
    - `labels` union: A filter on a Entity Array field: a value, which it matches exactly, or one of these operators: EqualTo, IsNull, NotNull, Includes. A list of ids, or Includes, matches the records related to any of them; IsNull those related to none.
      - string[]
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `webhookSecretKey` union: A filter on a Long Text field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes.
      - string
      - object
        - `_type` 'EqualTo', required
        - `value` string, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `incomingEmailSecretKey` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes.
      - string, uuid
      - object
        - `_type` 'EqualTo', required
        - `value` string, uuid, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, uuid, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, uuid, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `isWebhookSigningSecretSet` union: A filter on a Boolean field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull.
      - boolean
      - object
        - `_type` 'EqualTo', required
        - `value` boolean, required
      - object
        - `_type` 'NotEqual', required
        - `value` boolean, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` boolean, required
    - `lastWebhookRequestAt` union: A filter on a Date field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'EqualTo', required
        - `value` string, date-time, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `lastWebhookError` union: A filter on a Very Long Text field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes.
      - string
      - object
        - `_type` 'EqualTo', required
        - `value` string, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `lastWebhookErrorAt` union: A filter on a Date field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'EqualTo', required
        - `value` string, date-time, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
  - `select` WorkflowSelectSchema: Select schema for Workflow. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `name` boolean
    - `slug` boolean
    - `description` boolean
    - `createdByUserId` boolean
    - `deletedByUserId` boolean
    - `isArchived` boolean
    - `archivedAt` boolean
    - `archivedByUserId` boolean
    - `isEnabled` boolean
    - `graph` boolean
    - `labels` LabelRelationSelectSchema: What a select may name of the Label records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `name` boolean
      - `projectId` boolean
      - `color` boolean
      - `isArchived` boolean
    - `webhookSecretKey` boolean
    - `incomingEmailSecretKey` boolean
    - `isWebhookSigningSecretSet` boolean
    - `lastWebhookRequestAt` boolean
    - `lastWebhookError` boolean
    - `lastWebhookErrorAt` boolean
  - `sort` WorkflowSortSchema: Sort schema for Workflow. Only sortable fields are included.
    - `_id` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `createdAt` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `updatedAt` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `deletedAt` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `projectId` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `name` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `slug` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `description` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `createdByUserId` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `deletedByUserId` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `isArchived` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `archivedAt` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `archivedByUserId` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `isEnabled` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `webhookSecretKey` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `incomingEmailSecretKey` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `isWebhookSigningSecretSet` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `lastWebhookRequestAt` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `lastWebhookError` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
    - `lastWebhookErrorAt` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending).
  - `limit` number: Maximum number of items to return. Defaults to 10.
  - `skip` number: Number of items to skip for pagination. Defaults to 0.

## Response `200`

Successful response

- object
  - `data` Workflow[]
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Workflow, Project Member, Workflow Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [Project Owner, Project Admin, Edit Workflow, Workflow Admin]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Workflow, Project Member, Workflow Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [Project Owner, Project Admin, Edit Workflow, Workflow Admin]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Workflow, Project Member, Workflow Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [Project Owner, Project Admin, Edit Workflow, Workflow Admin]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Workflow, Project Member, Workflow Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [Project Owner, Project Admin, Edit Workflow, Workflow Admin]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Workflow, Project Member, Workflow Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [No access - you don't have permission for this operation]
    - `name` string, required: Any friendly name of this object. Permissions - Create: [Project Owner, Project Admin, Create Workflow, Project Member, Workflow Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [Project Owner, Project Admin, Edit Workflow, Workflow Admin]
    - `slug` string, required: Friendly globally unique name for your object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [No access - you don't have permission for this operation]
    - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Create Workflow, Project Member, Workflow Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [Project Owner, Project Admin, Edit Workflow, Workflow Admin]
    - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [No access - you don't have permission for this operation]
    - `deletedByUserId` string, uuid: User ID who deleted this object (if this object was deleted by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [No access - you don't have permission for this operation]
    - `isArchived` boolean, required: Archived workflows are hidden from the Workflows list and never run, from any trigger. Unarchiving restores them as they were. Permissions - Create: [Project Owner, Project Admin, Create Workflow, Project Member, Workflow Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [Project Owner, Project Admin, Edit Workflow, Workflow Admin]
    - `archivedAt` object: When this workflow was archived. Empty while it is not archived. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [No access - you don't have permission for this operation]
    - `archivedByUserId` string, uuid: User ID who archived this object (if this object was archived by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [No access - you don't have permission for this operation]
    - `isEnabled` boolean: Is this workflow enabled? Permissions - Create: [Project Owner, Project Admin, Create Workflow, Project Member, Workflow Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [Project Owner, Project Admin, Edit Workflow, Workflow Admin]
    - `graph` object: Workflow Graph in JSON. Ideally, create this via UI and not via API. Permissions - Create: [Project Owner, Project Admin, Create Workflow, Project Member, Workflow Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [Project Owner, Project Admin, Edit Workflow, Workflow Admin]
    - `labels` object[]: Labels to group and filter by. Permissions - Create: [Project Owner, Project Admin, Create Workflow, Project Member, Workflow Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [Project Owner, Project Admin, Edit Workflow, Workflow Admin]
      - `_id` string, uuid: Unique identifier for the entity
    - `webhookSecretKey` string: The secret part of the Webhook trigger's URL (/workflow/trigger/<key>). Anyone who has the URL can start the workflow, so only people who can edit the workflow can read the key. Generated when the workflow is created; set a new value to reset the URL. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Edit Workflow, Workflow Admin], Update: [Project Owner, Project Admin, Edit Workflow, Workflow Admin]
    - `incomingEmailSecretKey` string, uuid: The secret part of the Incoming Email trigger's address (workflow-<key>@<inbound email domain>). Anyone who has the address can start the workflow, so only people who can edit the workflow can read the key. Given to the workflow when its graph first has an Incoming Email trigger; set a new UUID to reset the address. Unique across all workflows. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Edit Workflow, Workflow Admin], Update: [Project Owner, Project Admin, Edit Workflow, Workflow Admin]
    - `isWebhookSigningSecretSet` boolean, required: Whether a webhook signing secret is saved. A trigger that checks signatures refuses every request until it is. Set by the server from the signing secret itself. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [No access - you don't have permission for this operation]
    - `lastWebhookRequestAt` object: When a request signed with the webhook signing secret last arrived. Empty until the sender's first one. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [No access - you don't have permission for this operation]
    - `lastWebhookError` string: Why the last request to a trigger that checks signatures was refused, if it was. Cleared by the next request that is accepted, and by saving a new signing secret. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [No access - you don't have permission for this operation]
    - `lastWebhookErrorAt` object: When the last webhook error happened. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow], Update: [No access - you don't have permission for this operation]
  - `count` number

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)
