# WorkflowModel

Data presentation model for Workflow

Type: object

Fields typed as another model are documented on that model's page; fetch it before filling the field.

| Field | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- |
| `id` | string | yes | Workflow identification |  |
| `name` | string | yes | Name of the workflow |  |
| `description` | string, nullable | yes | Description of the workflow |  |
| `category` | string, nullable | no | Category of the workflow |  |
| `owner` | string | yes | Owner of the workflow |  |
| `users` | array of string | yes | List of users in this workflow |  |
| `shared` | boolean | no | True if workflow is shared | default: `false` |
| `automations` | object with values of [WorkflowAutomationModel](https://dev-api.sheetgo.com/rest/reference/models/WorkflowAutomationModel.md) | yes | Automations present in this workflow |  |
| `forms` | array of string | yes | Forms present in this workflow |  |
| `scheduled` | boolean, nullable | no | True if workflow is scheduled | default: `false` |
| `running` | boolean, nullable | no | True if workflow is running | default: `false` |

## Used by

- [GET /rest/beta/workflows/](https://dev-api.sheetgo.com/rest/reference/workflows.md#get-rest-beta-workflows)
- [GET /rest/beta/workflows/{id}](https://dev-api.sheetgo.com/rest/reference/workflows.md#get-rest-beta-workflows-id)
- [PATCH /rest/beta/workflows/{id}](https://dev-api.sheetgo.com/rest/reference/workflows.md#patch-rest-beta-workflows-id)
- [POST /rest/beta/workflows/](https://dev-api.sheetgo.com/rest/reference/workflows.md#post-rest-beta-workflows)
- [PaginatedResponse_WorkflowModel_](https://dev-api.sheetgo.com/rest/reference/models/PaginatedResponse_WorkflowModel_.md)

---

More: start page https://dev-api.sheetgo.com/rest/reference.md, everything in one file https://dev-api.sheetgo.com/rest/llms-full.txt, OpenAPI https://dev-api.sheetgo.com/rest/openapi.json.