API Reference

Retrieve Agreement

Retrieve an agreement by ID.

Path Params
string
required

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

string
required

The ID of the agreement to query for.

Responses

Response body
object
object
string

A unique ID identifying the agreement.

string

A unique ID identifying the project that the agreement belongs to.

string

A unique ID identifying the design that the agreement belongs to.

string

The name of the template used to generate the agreement.

string

The status of the agreement.

cancel-pending canceled sent viewed signed error declined

string

The timestamp of when the agreement was last viewed, formatted as "YYYY-MM-DD HH:MM:SS UTC"

string

The timestamp of when the agreement was created, formatted as "YYYY-MM-DD HH:MM:SS UTC"

string

The timestamp of when the agreement was updated, formatted as "YYYY-MM-DD HH:MM:SS UTC"

string

The timestamp of when the agreement was sent, formatted as "YYYY-MM-DD HH:MM:SS UTC"

string

A description of the caught error.

Language
Credentials