---
title: "Get Agreement"
method: GET
path: "/analyze/v1/agreements/{id}"
tags: ["Analyze Agreements"]
---

# Get Agreement

`GET /analyze/v1/agreements/{id}`

## Request

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

Retrieve metadata for a specific agreement in Analyze.

## Path parameters

- `id` string, required

## Response `200`

successful

- object
  - `id` string, uuid, required: id
  - `original_name` string, required: original file name
  - `name` string, required: agreement name
  - `type` object, required: agreement type
    - `id` string, required: type id
    - `name` string, required: type name
  - `terms` object[], required: agreement terms
    - `value` string: value
    - `name` string: term type name
    - `status` string: status
    - `kind` string: term type kind
  - `tags` object[], required: tags
    - `name` string: name
  - `uploaded_by` string, required: full name of uploading user
  - `upload_date` string, required: uploaded date
  - `updated_date` string, required: updated date
  - `parent_agreement_id` string, required: parent agreement id
  - `finalize_agreement_id` string, required: finalize agreement id
  - `child_agreements` object[], required: child agreements
    - `id` string: child agreement id

## Other responses

- `403`: inactive user
- `404`: No record found for id
- `422`: invalid id 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)