---
title: "Get Agreement"
method: GET
path: "/finalize/v2/agreements/{agreement_id}"
tags: ["Finalize Agreements"]
---

# Get Agreement

`GET /finalize/v2/agreements/{agreement_id}`

## Path parameters

- `agreement_id` string, required

## Query parameters

- `include` 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.
    - `collaborator_ids` string[], required — Array of the agreement collaborator User UUIDs.
    - `status_id` string, uuid, nullable, required — The UUID of the current status record. Expected to be null if the agreement is not fully created.
    - `question_ids` string[], required — Array of the agreement question UUIDs.
    - `token_value_ids` string[], required — Array of the agreement token value UUIDs.
    - `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.
  - `_embedded` object, required — Includes the full sub-resource objects. Only present if ?include=embedded query parameter is supplied
    - `users` object[], required
      - `id` string, uuid, required — The UUID of the user record.
      - `first_name` string, required — The first name of the user.
      - `last_name` string, required — The last name of the user.
      - `email` string, required — The email of the user.
    - `questions` object[], required
      - `id` string, uuid, required — The UUID of the agreement question.
      - `answer_type` 'text' | 'paragraph' | 'date' | 'numbers' | 'multiple_selection' | 'single_selection' | 'file' | 'url', required — The answer type of the question.
      - `description` string, required — A description of what the question is asking.
      - `required` boolean, required — Whether the question is required or not.
      - `attachment_ids` string[] — List of agreement question attachment UUIDs.
      - `options` object[] — List of possible answer options.
        - `id` string, uuid, required
        - `description` string, required — The answer option value.
        - `custom_description` string — A user-defined description for the answer option
      - `answer` union, required
        - object
          - `id` string, uuid, required — The UUID of the answer.
          - `value` string, required — The answer value.
        - object
          - `id` string, uuid, required — The UUID of the answer.
          - `selected_option_ids` string[], required — List of the selected answer option UUIDs.
        - object
          - `id` string, uuid, required — The UUID of the answer.
          - `attachment_ids` string[], required — List of agreement answer attachment UUIDs.
    - `token_values` union[], required
      - union
        - object
          - `id` string, uuid, required — The UUID of the token value.
          - `token_id` string, uuid, required — The template token UUID associated with the token value.
          - `selected_option_ids` string[], required — The UUIDs of the selected answer options.
        - object
          - `id` string, uuid, required — The UUID of the token value.
          - `token_id` string, uuid, required — The template token UUID associated with the token value.
          - `value` string, required — The value of the token.
    - `statuses` object[], required
      - `id` string, uuid, required — The UUID of the agreement status record.
      - `name` string, required — The name of the agreement status.
      - `description` string, required — The description of the agreement status.
      - `internal_enum` string, required — A unique string to identify the agreement status.

## Other responses

- `404` — not_found
- `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)