---
title: "Retrieve Agreement Download URL"
method: GET
path: "/tenants/{tenant_id}/agreements/{id}/download_url/status"
tags: ["Agreements"]
---

# Retrieve Agreement Download URL

`GET /tenants/{tenant_id}/agreements/{id}/download_url/status`

## Request

- Base URL: `https://api-sandbox.aurorasolar.com`
- URL: `https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/agreements/{id}/download_url/status`
- Auth: HTTP bearer

Retrieves the status of an agreement download URL generation job.
---
You will need the `job_id` from the response body of a POST to the [Run Agreement Download URL Generation](ref:runagreementdownloadurlgeneration) endpoint, or from the parameters of a `agreement_download_url_job_completed` webhook call.
When the job succeeds, the response includes a `file_url` for downloading the PDF. The URL expires 15 minutes after generation.

## Path parameters

- `tenant_id` string, uuid, required
- `id` string, uuid, required

## Query parameters

- `job_id` string, uuid, required

## Response `200`

Job status retrieved.

- object
  - `agreement_download_url_job` object
    - `job_id` string, uuid: The unique ID of this async job.
    - `requested_at` string: The timestamp when the job was created, formatted as "YYYY-MM-DD HH:MM:SS UTC"
    - `completed_at` string, nullable: The timestamp when the job completed, formatted as "YYYY-MM-DD HH:MM:SS UTC". Null while in progress.
    - `status` 'in-progress' | 'succeeded' | 'failed': The current status of the download URL generation job.
    - `file_url` string, nullable: The short-lived URL to download the agreement PDF. Only present when status is "succeeded".
    - `filename` string, nullable: The sanitized filename for the agreement PDF. Only present when status is "succeeded".
    - `project_id` string, uuid: The ID of the project that the agreement belongs to.
    - `design_id` string, uuid: The ID of the design that the agreement belongs to.
    - `error` object, nullable: Error details if the job failed.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2026-11-03** `97a7ad8a993a`: 1 info
  - added the optional property `agreement_download_url_job/filename` to the response with the `200` status

[Operation history](https://skmtc.dev/aurorasolar/apis/sync-api/changes/tenants/:tenant_id/agreements/:id/download_url/status/get.md)

---

[API](https://skmtc.dev/aurorasolar/apis/sync-api.md) - [All operations](https://skmtc.dev/aurorasolar/apis/sync-api/llms.txt) - [OpenAPI document](https://skmtc.dev/aurorasolar/apis/sync-api/revisions/97a7ad8a993a?raw)