Agreements

Retrieve Agreement Link

Retrieves a download link and expiry time for a signed legacy agreement backed by Dropbox Sign. The link expires 72 hours after generation. This endpoint is rate-limited to 5 requests a minute. For Docusign agreements, use the Run Agreement Download URL Generation endpoint instead.

get/tenants/{tenant_id}/agreements/{id}/download_link

Request

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

Path parameters

tenant_idstring uuid required

The ID of the tenant that the project is part of.

idstring uuid required

The ID of the agreement to query for.

Response

Download link successfully retrieved.

Example response

{
  "agreement": {
    "file_url": "https://s3.amazonaws.com/hellofax_uploads/super_groups/2016/03/18/9aba07a585d7e223b4f137c8981c5e5892893c00/merged-completed.pdf?AWSAccessKeyId=AKIAJWEWDFQHQMBECJZA&Expires=1452868903&Signature=M%252FNDS%252BQre8xjPvzm7fHf%252BjO8Zbc%253D",
    "expires_at": "2023-05-23T21:49:57Z"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.