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

# GET /api/v1/Agreements

`GET /api/v1/Agreements`

## Query parameters

- `OrganizationId` integer
- `OrganizationIds` integer[], nullable
- `PricelistIds` integer[], nullable
- `Status` 0 | 1 | 2 | 3
- `AgreementTypes` AgreementType[], nullable
- `PublisherIds` integer[], nullable
- `ProgramIds` integer[], nullable
- `SearchDate` string, date-time, nullable
- `AgreementIds` integer[], nullable
- `SalesPriceCurrency` string, nullable
- `TermRequired` boolean
- `PublisherId` integer
- `EndDateFrom` string, date-time, nullable
- `EndDateTo` string, date-time, nullable
- `Page` integer
- `PageSize` integer
- `Search` string, nullable

## Response `200`

Success

- Agreement[]
  - `id` integer
  - `organization` ObjectReference
    - `id` integer
    - `name` string, nullable
  - `name` string, nullable
  - `salesPriceCurrencyCode` string, nullable
  - `startDate` string, date-time
  - `endDate` string, date-time
  - `disabled` boolean
  - `publisher` ObjectReference
    - `id` integer
    - `name` string, nullable
  - `program` ObjectReference
    - `id` integer
    - `name` string, nullable
  - `number` string, nullable
  - `customerNumber` string, nullable
  - `masterAgreement` string, nullable
  - `hasTerms` boolean
  - `agreementType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13
  - `parentAgreementId` integer, nullable
  - `commitmentLevel` number, double
  - `consumerId` integer, 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/revisions/a04494a78f65/schema)