---
title: "Get Jobs"
method: GET
path: "/api/v2/jobs"
tags: ["Jobs"]
---

# Get Jobs

`GET /api/v2/jobs`

## Request

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

Gets a collection of Jobs. When successful, the response is a PagedResponse of Jobs.
            If unsuccessful, an appropriate ApiError is returned. 
            ///

## Query parameters

- `limit` integer
- `offset` integer
- `isIncludeDeleted` boolean

## Response `200`

OK

- APIPagedResponseBuildSystemSharedDTOJob: 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` BuildSystemSharedDTOJob[], required: The set of entities that make up this page.
    - `JobID` integer: The ID of the job
    - `Name` string: The name of the job
    - `Deleted` boolean: Indicates if the job has been deleted.
    - `Parameters` BuildSystemSharedDTOParameter[]: The parameters for the job
      - `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)
    - `Activities` BuildSystemSharedDTOJobActivity[]: The activities which are performed for the job
      - `JobActivityID` integer: The ID of this job activity
      - `JobID` integer: The ID of the job this job activity belongs to
      - `ActivityID` integer: The ID of the activity to be run as part of the job
      - `RunOrder` integer: The order of this job activity relative to others in the job
      - `ParameterMappings` BuildSystemSharedDTOParameterMapping[]: The mapping of values from a source to be used for the activity 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)