Retrieve Agreement

Retrieve an agreement by ID. Returns either an agreement backed by Docusign or Dropbox Sign. The signing_provider field in the response indicates which provider the agreement is backed by.

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

Request

Base URL
https://api-sandbox.aurorasolar.com
URL
https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/agreements/{id}
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

Agreement successfully retrieved.

Example response

{
  "agreement": {
    "id": "839811ef-ee81-4ce2-8b6c-0cda53e4d818",
    "project_id": "e9990fc0-5115-49be-8e93-ea472b8b3626",
    "design_id": "b54c358a-bb1d-4716-81f6-01246005ca88",
    "agreement_template_name": "Agreement Template 1",
    "status": "sent",
    "last_viewed_at": "2023-07-11 18:43:18 UTC",
    "created_at": "2023-07-11 18:43:18 UTC",
    "sent_at": "2023-07-11 18:43:18 UTC",
    "signing_provider": "dropbox_sign"
  }
}

Changes

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