---
title: "List customer agreements by reference"
method: GET
path: "/platform/v2/agreements"
tags: ["Agreements"]
---

# List customer agreements by reference

`GET /platform/v2/agreements`

## Request

- Base URL: `https://api.sandbox.bvnk.com`
- URL: `https://api.sandbox.bvnk.com/platform/v2/agreements`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/platform/v2/agreements/get.ts> (a function with typed inputs; its response is checked against the schema)

List the agreement working set previously created for the given partner-supplied `reference`.

## Query parameters

- `reference` string, required

## Response `200`

Agreement working set for the supplied reference

- V2PreCustomerAgreementsResponse: Agreement working set returned by the create and list-by-reference endpoints.
  - `id` string, uuid: Unique identifier of the customer.
  - `reference` string: Partner-supplied identifier that scopes the working set.
  - `agreements` V2PreCustomerAgreement[]: Agreements in the working set.
    - `id` string, uuid: Unique identifier of the customer agreement entry.
    - `name` string: Human-readable agreement title.
    - `description` string: Short summary of what the agreement covers.
    - `declinable` boolean: Whether the customer may reject the agreement. When `false`, only `ACCEPT` is valid.
    - `status` 'PENDING' | 'ACCEPTED' | 'REJECTED': Current state of the agreement entry.
    - `respondedAt` string, date-time: Timestamp at which the customer responded. Absent while `status` is `PENDING`.
  - `signingUrl` string: URL where the customer can review and sign the agreements.

## Other responses

- `401`: Unauthorized
- `404`: The specified resource was not found

## Changes

- **2026-11-06** `c386d436bf2c`: 1 warning, 2 info
  - removed the optional property `agreements/items/expiresAt` from the response with the `200` status
  - added the optional property `id` to the response with the `200` status
  - added the optional property `signingUrl` to the response with the `200` status
- **2026-06-16** `97d6c0d2fe2e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/changes/platform/v2/agreements/get.md)

---

[API](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints.md) - [All operations](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/revisions/c386d436bf2c?raw)