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

# Get Agreement File URL

`GET /analyze/v2/agreements/{id}/download`

## Request

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

Retrieve a URL to download the file of a specific agreement in Analyze, with an option to use the original or smart-renamed file.

## Path parameters

- `id` string, required

## Query parameters

- `use_original_name` boolean

## Response `200`

successful with params

- object
  - `data` object, required

## Other responses

- `403`: failure when user does not have an access
- `404`: failure with agreement not found
- `422`: validation failure on value

---

[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)
