---
title: "Get a workflow step"
method: GET
path: "/api/v1/workflow-steps/{id}"
tags: ["Workflow Steps"]
---

# Get a workflow step

`GET /api/v1/workflow-steps/{id}`

## Request

- Base URL: `https://api.atono.io`
- URL: `https://api.atono.io/api/v1/workflow-steps/{id}`
- Auth: API key in header `X-API-KEY`

## Path parameters

- `id` string, uuid, required

## Response `200`

Successfully retrieved the workflow step.

- SingleResourceBodyWorkflowStepResourceV1
  - `data` WorkflowStepResourceV1: A workflow step represents a stage in the team's workflow process. Stories and bugs move through these steps as they progress from creation to completion. Each step has a category (To do, In progress, Done, or Won't do) and can be configured to accept stories, bugs, or both.
    - `type` string: Identifies the type of resource.
    - `id` string, uuid: The unique identifier for the resource, typically a UUID.
    - `attributes` WorkflowStepResourceV1Attributes: Contains the structured data fields that describe the resource, such as properties, settings, and timestamps.
      - `name` string: The name of the workflow step.
      - `category` 'TODO' | 'IN_PROGRESS' | 'DONE' | 'WONT_DO': The category of the workflow step. Valid values are `TODO` (To do), `IN_PROGRESS` (In progress), `DONE` (Done), or `WONT_DO` (Won't do). The category determines the general stage of work items in this step.
      - `position` integer: The position of the workflow step within its category. Steps are ordered by category first, then by position within the category.
      - `color` string: The color associated with the workflow step, typically used for visual representation in the Atono application.
      - `stepType` 'TODO' | 'DESIGN' | 'DEV' | 'TEST' | 'REVIEW' | 'DONE' | 'WONTDO' | 'REPORTED' | 'INFO_REQUIRED' | 'CUSTOM': The high-level classification of the workflow step. Determines the default color shown in the Atono application if no custom color is set, and helps identify the most appropriate step to move items to when a step is deleted or the workflow is reset.
      - `forStory` boolean: Indicates whether stories can be assigned to this workflow step (`true`) or not (`false`).
      - `forBug` boolean: Indicates whether bugs can be assigned to this workflow step (`true`) or not (`false`).
      - `allowNewItems` boolean: Indicates whether new backlog items can be created directly in this workflow step (`true`) or not (`false`).
  - `errors` ProblemDetail[]: A list of errors returned with the response, if the request could not be completed. Each object includes details about a specific issue.
    - `id` string: A unique identifier for this specific error occurrence. Useful for debugging and support.
    - `links` object, nullable: Links related to the error. May include a URL to relevant documentation or support resources.
    - `status` integer: The HTTP status code associated with the error (e.g., 400, 404, 422).
    - `code` string: An internal code that identifies the type or category of the error.
    - `title` string: A short summary of the problem.
    - `source` ProblemSource: Identifies the part of the request that caused the error. Only one source is present per error.
      - `pointer` string, nullable: Specifies the path to the field in the request body that caused the error.
      - `parameter` string, nullable: Identifies a query parameter in the request URL that caused the error.
      - `header` string, nullable: Identifies the request header that caused the error.
    - `detail` string: Additional information about the error, intended to provide more context than the title.
    - `meta` unknown
  - `meta` unknown
  - `included` unknown[]: A list of related resources included in the response, either automatically by the API or in response to an include parameter in the request. Each item contains a full resource object (e.g., users, teams, acceptance criteria).
    - unknown
  - `links` unknown

## Other responses

- `404`: The workflow step could not be found.

---

[API](https://skmtc.dev/atono/apis/backend-api.md) · [All operations](https://skmtc.dev/atono/apis/backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/atono/apis/backend-api/revisions/78a57b1d8c3d?raw)