---
title: "List Agreements"
method: GET
path: "/analyze/v1/agreements"
tags: ["Analyze Agreements"]
---

# List Agreements

`GET /analyze/v1/agreements`

## Request

- Base URL: `https://api.linksquares.com/api`
- URL: `https://api.linksquares.com/api/analyze/v1/agreements`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/linksquares/apis/linksquares-api/docs/analyze/v1/agreements/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of agreements in Analyze, with options to filter and paginate.

## Query parameters

- `type` string
- `tags` string
- `after_date` string
- `sort_by` string
- `cursor` string
- `tags_delimiter` string
- `page_size` string

## Response `200`

success

- object
  - `page_size` integer, required: The number of results displayed
  - `count` integer, required: Total number of results found
  - `next_cursor` string, uuid, nullable, required: The string that must be passed to the cursor parameter to get the next page of results
  - `agreements` object[], nullable, required
    - `id` string: UUID of the Agreement
    - `parent_agreement_id` string, nullable: UUID of the Parent Agreement
    - `finalize_agreement_id` string, nullable: UUID of the Finalize Agreement
    - `name` string: Agreement Name
    - `original_name` string: Original File Name
    - `updated_date` string: Last Updated Date of Agreement
    - `upload_date` string: Upload Date of the Agreement
    - `uploaded_by` string: Name of User who Uploaded Agreement
    - `type` object
      - `id` string, uuid: UUID of the Agreement Type
      - `name` string: Name of the Agreement Type
    - `tags` object[], nullable
      - `id` string: UUID of the tag
      - `name` string: The name of the tag
    - `child_agreements` object[], nullable
      - `id` string, uuid: UUID of the Child Agreement
    - `terms` object[], nullable
      - `id` string: UUID of the term
      - `name` string: The name of the term
      - `value` string, nullable: The value of the term
      - `kind` string: The kind of the term
      - `status` string: The status of the term

## Other responses

- `403`: inactive user
- `422`: wrong date format

---

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