---
title: "GET /api/v1/AgreementProducts"
method: GET
path: "/api/v1/AgreementProducts"
tags: ["AgreementProducts"]
---

# GET /api/v1/AgreementProducts

`GET /api/v1/AgreementProducts`

## Query parameters

- `AgreementTypeIds` AgreementType[], nullable
- `Page` integer
- `PageSize` integer
- `Search` string, nullable
- `PriceListId` integer
- `OrganizationId` integer
- `CustomerTenantId` integer
- `AgreementId` integer
- `IsTrial` boolean, nullable
- `AgreementIds` integer[], nullable
- `SearchDate` string, date-time, nullable
- `Include.PartNumbers` string[], nullable
- `Include.PublisherIds` integer[], nullable
- `Include.PublisherNames` string[], nullable
- `Include.PoolNames` string[], nullable
- `Include.OperatingSystemNames` string[], nullable
- `Include.LevelNames` string[], nullable
- `Include.LanguageNames` string[], nullable
- `Include.LicenseAgreementTypeNames` string[], nullable
- `Include.LicenseTypeNames` string[], nullable
- `Include.ProductFamilyNames` string[], nullable
- `Include.ProductTypeNames` string[], nullable
- `Include.ProgramNames` string[], nullable
- `Include.OfferingNames` string[], nullable
- `Include.PurchasePeriodNames` string[], nullable
- `Include.PurchaseUnitNames` string[], nullable
- `Include.VersionNames` string[], nullable
- `Include.RegionNames` string[], nullable
- `Include.ProductCategoryNames` string[], nullable
- `Include.CatalogNames` string[], nullable
- `Include.BillingCycles` string[], nullable
- `Include.AttributesRegions` string[], nullable
- `Include.AttributesVCpus` string[], nullable
- `Include.AttributesRams` string[], nullable
- `Include.AttributesCores` string[], nullable
- `Include.AttributesCategories` string[], nullable
- `Include.AttributesDiskSizes` string[], nullable
- `Include.AttributesGroupNames` string[], nullable
- `Exclude.PartNumbers` string[], nullable
- `Exclude.PublisherIds` integer[], nullable
- `Exclude.PublisherNames` string[], nullable
- `Exclude.PoolNames` string[], nullable
- `Exclude.OperatingSystemNames` string[], nullable
- `Exclude.LevelNames` string[], nullable
- `Exclude.LanguageNames` string[], nullable
- `Exclude.LicenseAgreementTypeNames` string[], nullable
- `Exclude.LicenseTypeNames` string[], nullable
- `Exclude.ProductFamilyNames` string[], nullable
- `Exclude.ProductTypeNames` string[], nullable
- `Exclude.ProgramNames` string[], nullable
- `Exclude.OfferingNames` string[], nullable
- `Exclude.PurchasePeriodNames` string[], nullable
- `Exclude.PurchaseUnitNames` string[], nullable
- `Exclude.VersionNames` string[], nullable
- `Exclude.RegionNames` string[], nullable
- `Exclude.ProductCategoryNames` string[], nullable
- `Exclude.CatalogNames` string[], nullable
- `Exclude.BillingCycles` string[], nullable
- `Exclude.AttributesRegions` string[], nullable
- `Exclude.AttributesVCpus` string[], nullable
- `Exclude.AttributesRams` string[], nullable
- `Exclude.AttributesCores` string[], nullable
- `Exclude.AttributesCategories` string[], nullable
- `Exclude.AttributesDiskSizes` string[], nullable
- `Exclude.AttributesGroupNames` string[], nullable
- `SortKey` string, nullable
- `IncludeProductInformation` boolean
- `IncludeProductVariantInformation` boolean
- `IncludeEndOfSale` boolean, nullable
- `SortOrder` 0 | 1

## Response `200`

Success

- AgreementProduct[]
  - `uniqueId` string, nullable
  - `productType` 0 | 1 | 2 | 3
  - `productVariant` ProductVariant
    - `id` integer
    - `product` ProductReference
      - `id` integer
      - `partNumber` string, nullable
      - `publisherProductId` string, nullable
      - `itemLegalName` string, nullable
      - `itemName` string, nullable
    - `partNumber` string, nullable
    - `productName` string, nullable
    - `publisher` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `program` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `productFamily` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `language` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `level` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `productType` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `pool` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `licenseType` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `licenseAgreementType` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `operatingSystem` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `offering` ObjectReference
      - `id` integer
      - `name` string, nullable
    - `minimumCommitment` MinimumCommitmentLight
      - `id` integer
      - `months` integer
      - `name` string, nullable
    - `unitCount` integer
    - `version` string, nullable
    - `purchaseUnit` string, nullable
    - `purchasePeriod` string, nullable
    - `addDate` string, date-time
    - `deleteDate` string, date-time
    - `productCategory` string, nullable
    - `region` string, nullable
    - `isTrial` boolean
    - `defaultBillingCycleId` integer
    - `availableBillingCycleIds` integer[], nullable
    - `attributes` object, nullable
    - `minimumQuantity` number, double
    - `maximumQuantity` number, double, nullable
    - `provisioningVariables` string[], nullable
  - `agreement` ObjectReference
    - `id` integer
    - `name` string, nullable
  - `name` string, nullable
  - `priceId` integer
  - `recommendedRetailPrice` Price
    - `value` number, double
    - `currencyCode` string, nullable
  - `salesPrice` Price
    - `value` number, double
    - `currencyCode` string, nullable
  - `alternativeSalesPrice` Price
    - `value` number, double
    - `currencyCode` string, nullable
  - `endOfSale` EndOfSale
    - `endOfSaleStartDate` string, date-time, nullable
    - `endOfSaleEndDate` string, date-time, nullable
  - `priceListId` integer
  - `priceListName` string, nullable
  - `monthMultiplier` integer
  - `priceCalculationType` 0 | 1 | 2 | 3 | 4
  - `agreementType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13
  - `productInformation` ProductInformation
    - `externalProductId` integer
    - `cultureCode` string, nullable
    - `description` string, nullable
    - `learnMoreLink` string, nullable
  - `minimumQuantity` integer
  - `maximumQuantity` integer, nullable
  - `catalog` ObjectReference
    - `id` integer
    - `name` string, nullable
  - `productVariantInformation` ProductVariantInformation
    - `description` string, nullable

---

[API](https://skmtc.net/crayon/apis/crayon-group-customer-api.md) · [All operations](https://skmtc.net/crayon/apis/crayon-group-customer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crayon/crayon-group-customer-api/versions/a04494a78f65/schema)