---
title: "List Agreements"
method: GET
path: "/finalize/v2/agreements"
tags: ["Finalize Agreements"]
---

# List Agreements

`GET /finalize/v2/agreements`

## Query parameters

- `page` integer
- `per_page` integer
- `filter` array[]
  - string[]

## Response `200`

success

- object
  - `data` object[], required
    - `id` string, uuid, required — The UUID of the agreement record.
    - `name` string, required — The name of the agreement.
    - `created_at` string, date-time, required — The ISO 8601 datetime of when the agreement record was created.
    - `status_updated_at` string, date-time, nullable, required — The ISO 8601 datetime of when the agreement status was updated. Expected to be null if the agreement is not fully created.
    - `kind` 'draft' | 'intake' | 'request' | 'sign' | 'webform', required — The kind of the agreement.
    - `analyze_agreement_id` string, uuid, nullable, required — The UUID of the Analyze agreement that was created and referenced by a Fully Signed Finalize agreement.
    - `template_id` string, uuid, nullable, required — The UUID of the template the agreement was created from. Expected to be null if the agreement was not created from a template.
    - `author_id` string, uuid, required — The UUID of the user record that created the agreement.
    - `owner_id` string, uuid, nullable, required — The UUID of the user record that is currently the agreement owner. Expected to be null if the agreement does not have an owner.
    - `status_id` string, uuid, nullable, required — The UUID of the current status record. Expected to be null if the agreement is not fully created.
    - `pen` object
      - `assigned_to_counterparty` boolean — Indicates whether the pen is assigned to the counterparty.
      - `holder_ids` string[] — Array of the agreement pen holder User UUIDs.
  - `total_count` integer, required — Total number of items returned
  - `_links` object, required
    - `next` object
      - `href` string — URL to the next page of items (null if none)
    - `prev` object
      - `href` string — URL to the previous page of items (null if none)

## Other responses

- `422` — unprocessable_entity

---

[API](https://skmtc.net/linksquares/apis/linksquares-api.md) · [All operations](https://skmtc.net/linksquares/apis/linksquares-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/linksquares/linksquares-api/revisions/4d597e83cd78/schema)