---
title: "Get a Client's Available Update Group Subscriptions"
method: GET
path: "/api/v2/Clients/{ID}/AvailableUpdateGroupSubscriptions"
tags: ["Clients"]
---

# Get a Client's Available Update Group Subscriptions

`GET /api/v2/Clients/{ID}/AvailableUpdateGroupSubscriptions`

## Request

- Base URL: `https://secure.agco-ats.com`
- URL: `https://secure.agco-ats.com/api/v2/Clients/{ID}/AvailableUpdateGroupSubscriptions`
- Auth: none declared

No Documentation Found.

## Path parameters

- `ID` string, required

## Query parameters

- `UpdateGroupID` string
- `limit` integer
- `offset` integer

## Response `200`

OK

- APIPagedResponseUpdateSystemModelsAvailableUpdateGroupSubscription: 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` UpdateSystemModelsAvailableUpdateGroupSubscription[], required: The set of entities that make up this page.
    - `UpdateGroup` UpdateSystemModelsUpdateGroup
      - `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
    - `AvailableSubscriptions` UpdateSystemModelsAvailableSubscription[]: The available subscriptions for this update group.
      - `PackageType` UpdateSystemModelsPackageType
        - `PackageTypeID` string: Read Only. The package type id.
        - `Description` string, required: The description of the package type
        - `InventoryPackage` string: The inventory package used to determine what version of this package type is installed.
        - `Category` string: The inventory category (from the InventoryPackage) used to determine what version of this package type is installed.
        - `Attribute` string: The inventory attribute (from the InventoryPackage) used to determine what version of this package type is installed.
        - `InventoryFrequency` integer: The number of minutes to wait before requesting another inventory. The default value is 1440 (24 hours).
        - `MaxDeltaPackages` integer: The maximum number of "chained" delta packages to use when updating the client
        - `LocalizedDescription` string: Optional. The StringID used to localize the description of the PackageType
        - `LocalizedName` string: Optional. The StringID used to localize the name of the PackageType
        - `Icon` string: Optional. The icon to use for the PackageType, in base 64
      - `SubscriptionType` 'Required' | 'IncludeByDefault' | 'ExcludeByDefault': The type of subscription supported.

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