---
title: "Get an Activity by ID"
method: GET
path: "/api/v2/activities/{activityID}"
tags: ["Activities"]
---

# Get an Activity by ID

`GET /api/v2/activities/{activityID}`

## Request

- Base URL: `https://secure.agco-ats.com`
- URL: `https://secure.agco-ats.com/api/v2/activities/{activityID}`
- Auth: none declared

Gets an Activity by ID. When successful, the response is the requested Activity.  If unsuccessful,
            an appropriate ApiError is returned.

## Path parameters

- `activityID` integer, required

## Query parameters

- `isIncludeDeleted` boolean

## Response `200`

OK

- BuildSystemSharedDTOActivity: A DTO for an IActivity
  - `ActivityID` integer: The ID of the activity
  - `Name` string: The name of the activity
  - `Deleted` boolean
  - `Parameters` BuildSystemSharedDTOParameter[]: The parameters for this activity
    - `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)
  - `Steps` BuildSystemSharedDTOActivityStep[]: The steps which are performed for this activity
    - `ActivityStepID` integer: The id of this activity step
    - `ActivityID` integer: The id of the activity this activity step belongs to
    - `StepID` integer: The id of the step
    - `RunOrder` integer: The order of this activity step relative to other activity steps
    - `UseConfig` string: Indicates the configuration for the ActivityStep to use at runtime. The build agent must provide this configuration
    - `StepName` string: The name of the step
    - `ImplementationID` string: The implementation id which is used to look up the step implementation
    - `ParameterMappings` BuildSystemSharedDTOParameterMapping[]: The mapping of values from a source to be used for the step parameters
      - `Name` string: The name of the parameter this mapping applies to
      - `SourceType` 'Constant' | 'Variable': The source type used for supplying the parameter
      - `Source` string: The source of the value. The meaning of this value is determined by the source type. When the source type is “Constant” then source is the value formatted as a string. When the source type is “Variable” then the source is the name of the variable

## 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)