---
title: "Get a list of Update Groups. Update Groups are used by the client to register for a specific type of update."
method: GET
path: "/api/v2/UpdateGroups"
tags: ["UpdateGroups"]
---

# Get a list of Update Groups. Update Groups are used by the client to register for a specific type of update.

`GET /api/v2/UpdateGroups`

## Request

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

No Documentation Found.

## Query parameters

- `limit` integer
- `offset` integer
- `userID` integer

## Response `200`

OK

- APIPagedResponseUpdateSystemModelsUpdateGroup: 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` UpdateSystemModelsUpdateGroup[], required: The set of entities that make up this page.
    - `ID` string
    - `Description` string, required: The description of the update group
    - `UpdateType` string, required: The update type name
    - `InventoryPackage` string: The Package ID of the package used for inventory
    - `ReportField` string: A field to return in the status report for this update group. Specify the field with the format [Label]: {[InventoryPackageID].[Category].[Attribute]}. (i.e. example: {bec778ca-278d-424a-867a-4653a1a19e86.MyCategory.MyAttribute})
    - `ValidatingField` string: A field used for validation in the status report for this update group. Specify the field with the format [Label]: {[InventoryPackageID].[Category].[Attribute]}. (i.e. example: {bec778ca-278d-424a-867a-4653a1a19e86.MyCategory.MyAttribute})
    - `ValueToValidate` string: The value to validate the ValidationField against.
    - `InventoryFrequency` integer: The time in minutes between inventory checks. Default value is 1440 minutes (one day).
    - `Priority` integer, required: The execution priority of the package relative to other packages in the bundle. Range 1 - 100, lower value indication higher priority.
    - `Version` string, byte: The version of the UpdateGroup, this value is incremented with each modification to a related Bundle or PackageType
    - `LocalizedDescription` string: Optional. The StringID used to localize the description of the update group
    - `LocalizedName` string: Optional. The StringID used to localize the name of the update group

## Other responses

- `default`: API Error Response

## Changes

- **2022-09-25** `64b7a32ab769`: 1 info
  - added the new optional `query` request parameter `userID`

[Operation history](https://skmtc.dev/agco-ats/apis/agco-ats-api/changes/api/v2/UpdateGroups/get.md)

---

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