---
title: "Bulk get workflow schemes"
method: POST
path: "/rest/api/2/workflowscheme/read"
tags: ["Workflow schemes"]
---

# Bulk get workflow schemes

`POST /rest/api/2/workflowscheme/read`

Returns a list of workflow schemes by providing workflow scheme IDs or project IDs.

**[Permissions](#permissions) required:**

 *  *Administer Jira* global permission to access all, including project-scoped, workflow schemes
 *  *Administer projects* project permissions to access project-scoped workflow schemes

## Request body

- WorkflowSchemeReadRequest — The workflow scheme read request body.
  - `projectIds` string[], nullable — The list of project IDs to query.
  - `workflowSchemeIds` string[], nullable — The list of workflow scheme IDs to query.

## Response `200`

Returned if the request is successful.

- WorkflowSchemeReadResponse[]
  - `defaultWorkflow` WorkflowMetadataRestModel — Workflow metadata and usage detail.
    - `description` string, required — The description of the workflow.
    - `id` string, required — The ID of the workflow.
    - `name` string, required — The name of the workflow.
    - `version` DocumentVersion, required — The current version details of this workflow scheme.
      - `id` string — The version UUID.
      - `versionNumber` integer — The version number.
  - `description` string, nullable — The description of the workflow scheme.
  - `id` string, required — The ID of the workflow scheme.
  - `name` string, required — The name of the workflow scheme.
  - `scope` WorkflowScope, required — The scope of the workflow.
    - `project` ProjectId, nullable — Project ID details.
      - `id` string, required — The ID of the project.
    - `type` 'PROJECT' | 'GLOBAL' — The scope of the workflow. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects.
  - `taskId` string, nullable — Indicates if there's an [asynchronous task](#async-operations) for this workflow scheme.
  - `version` DocumentVersion, required — The current version details of this workflow scheme.
    - `id` string — The version UUID.
    - `versionNumber` integer — The version number.
  - `workflowsForIssueTypes` WorkflowMetadataAndIssueTypeRestModel[], required — Mappings from workflows to issue types.
    - `issueTypeIds` string[], required — The list of issue type IDs for the mapping.
    - `workflow` WorkflowMetadataRestModel, required — Workflow metadata and usage detail.
      - `description` string, required — The description of the workflow.
      - `id` string, required — The ID of the workflow.
      - `name` string, required — The name of the workflow.
      - `version` DocumentVersion, required — The current version details of this workflow scheme.
        - `id` string — The version UUID.
        - `versionNumber` integer — The version number.

## Other responses

- `400` — Returned if the request is not valid.
- `401` — Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api/versions/a26541c2f8bd/schema)