---
title: "OPTIONS /workflows"
method: OPTIONS
path: "/workflows"
tags: ["Workflows"]
---

# OPTIONS /workflows

`OPTIONS /workflows`

OPTIONS operation for /workflows

## Response `200`

Successful response

- WorkflowSerializer
  - `id` integer
  - `name` string, required
  - `workflow_type` 'quick_action' | 'event' | 'scheduled', required
  - `workflow_actions` string
  - `workflow_actions_display` string
  - `trigger` 'map-created' | 'map-updated' | 'map-status-updated' | 'map-owner-updated' | 'map-task-created' | 'map-task-assignee-updated' | 'map-task-due-date-updated' | 'map-task-status-updated' | 'map-section-completed' | 'discussion-message-created' | 'customer-created' | 'customer-updated' | 'custom-form-submitted' | 'document-completed' | 'document-voided' — Only required when workflow_type=event
  - `trigger_display` string
  - `internal_description` string
  - `created_at` string, date-time
  - `modified_at` string, date-time
  - `created_by` string
  - `button_color` string
  - `button_placement` 'map' | 'map_task'
  - `button_title` string
  - `is_enabled` boolean
  - `filters` object
  - `filters_rql` string
  - `workflow_events` string
  - `is_hidden` boolean
  - `schedule_type` 'daily' | 'weekly' | 'monthly'
  - `schedule_day` integer — Day of the week as an integer (0 for Monday, 6 for Sunday)
  - `schedule_time` string, time

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found

---

[API](https://skmtc.dev/onboard/apis/onboard-api-complete-specification.md) · [All operations](https://skmtc.dev/onboard/apis/onboard-api-complete-specification/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/onboard/onboard-api-complete-specification/revisions/3d0f0a6a632d/schema)