v1

latestOpenAPI 3.0.02026-07-241010520.6 KB

Agreements

List Agreements

Returns a list of agreements for a project.

Agreements are returned sorted in descending order based on creation date. Each item includes a signing_provider field indicating whether the agreement is backed by docusign or dropbox_sign.

get/tenants/{tenant_id}/projects/{project_id}/agreements

Path parameters

tenant_idstring uuid required

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

project_idstring uuid required

The ID of the project to query for.

Response

Agreements successfully retrieved.

Example response

{
  "agreements": [
    {
      "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",
      "created_at": "2023-07-11 18:43:18 UTC",
      "signing_provider": "dropbox_sign"
    }
  ]
}