v1

latestOpenAPI 3.0.02026-07-241010520.6 KB

Agreements

Retrieve Agreement Download URL

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 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.

get/tenants/{tenant_id}/agreements/{id}/download_url/status

Path parameters

tenant_idstring uuid required

The ID of the tenant.

idstring uuid required

The ID of the Docusign agreement.

Query parameters

job_idstring uuid required

The ID of the download URL generation job returned by the run endpoint.

Response

Job status retrieved.

Example response

{
  "agreement_download_url_job": {
    "job_id": "4f3e2d1c-0b9a-8765-4321-fedcba987654",
    "requested_at": "2024-01-15 10:30:00 UTC",
    "completed_at": "2024-01-15 10:30:05 UTC",
    "status": "succeeded",
    "file_url": "https://storage.example.com/api/blob/48831006cdbe0b69670ca41a58603d0e?token=xyz",
    "project_id": "e9990fc0-5115-49be-8e93-ea472b8b3626",
    "design_id": "b54c358a-bb1d-4716-81f6-01246005ca88"
  }
}