---
title: "Get Steps"
method: GET
path: "/api/v2/steps"
tags: ["Steps"]
---

# Get Steps

`GET /api/v2/steps`

## Request

- Base URL: `https://secure.agco-ats.com`
- URL: `https://secure.agco-ats.com/api/v2/steps`
- Auth: none declared

Gets a collection of Steps. When successful, the response is a PagedResponse of Steps.
            If unsuccessful, an appropriate ApiError is returned.  Steps.Read permission is required.

## Query parameters

- `limit` integer
- `offset` integer
- `includeDeleted` boolean

## Response `200`

OK

- APIPagedResponseBuildSystemSharedDTOStep: A response containing a page of results and metadata concerning the results
  - `Metadata` APIPagedResponseMetadata, required: Metadata for the paged response
    - `TotalCount` integer, required: The total number of entities matching the request.
    - `Limit` integer, required: The number of entities this paged response is limited to.
    - `Offset` integer, required: The number of entities prior to this page of items.
  - `Entities` BuildSystemSharedDTOStep[], required: The set of entities that make up this page.
    - `StepID` integer: The ID of the step
    - `Name` string, required: The name of the step
    - `ConfigRequired` boolean, required: Indicates if the step requires configuration values to be provided by the build agent
    - `Description` string: A description of the step to be presented to a user
    - `ImplementationID` string, required: The implementation ID used to lookup the step implementation when it is executed
    - `Deleted` boolean: Read Only. Indicates if the record is deleted.
    - `Parameters` BuildSystemSharedDTOParameter[]: The parameters for this step
      - `Name` string: The name of the parameter
      - `Type` 'String' | 'Boolean' | 'Integer' | 'Float' | 'StringDictionary': The data type of the parameter
      - `Direction` 'Input' | 'Output': The parameter direction (Input or Output)

## Other responses

- `default`: API Error Response

---

[API](https://skmtc.dev/agco-ats/apis/agco-ats-api.md) - [All operations](https://skmtc.dev/agco-ats/apis/agco-ats-api/llms.txt) - [OpenAPI document](https://skmtc.dev/agco-ats/apis/agco-ats-api/revisions/8b416443df5c?raw)