Skip to content
Quarters Developers
esc
  • Type an endpoint, an object or a word from a guide.

Object

Agreement

The tenancy agreement on a booking, in its current version.

Fields

FieldTypeDescription
id string
version integerCounts up on every re-issue. Superseded versions are not listed.
provider enumquarters for an envelope Quarters issued itself, external for one written through this API. "quarters""external"
externalId string | nullYour stable id for the envelope, as you reported it.
status enum "sent""completed""declined""failed""superseded""voided"
templateName string | nullThe Quarters template used; null for an external envelope.
sentAt timestamp | null ISO 8601
completedAt timestamp | null ISO 8601
declinedAt timestamp | null ISO 8601
voidedAt timestamp | null ISO 8601
error string | nullWhy it failed. Only kept while status is failed.
documentUrl string | nullThe provider-hosted copy of the executed document, as reported.
document object | nullSet once the executed PDF has been archived: by Quarters for its own envelopes, by you through the document endpoint for yours.
signers Signer[]
createdAt timestamp ISO 8601
updatedAt timestamp ISO 8601

Used by

Example

{
  "id": "9a41…",
  "version": 1,
  "provider": "external",
  "externalId": "docuseal:1849213",
  "status": "sent",
  "templateName": null,
  "sentAt": "2026-09-08T10:02:11.000Z",
  "completedAt": null,
  "declinedAt": null,
  "voidedAt": null,
  "error": null,
  "documentUrl": null,
  "document": null,
  "signers": [
    {
      "role": "lessor",
      "name": "City Retreat B.V.",
      "email": "bookings@cityretreat.com",
      "status": "completed",
      "signingUrl": null,
      "viewedAt": null,
      "completedAt": "2026-09-08T10:02:11.000Z",
      "declinedAt": null,
      "declineReason": null
    },
    {
      "role": "lessee",
      "name": "Sofia Rossi",
      "email": "sofia@example.com",
      "status": "pending",
      "signingUrl": "https://docuseal.com/s/…",
      "viewedAt": null,
      "completedAt": null,
      "declinedAt": null,
      "declineReason": null
    }
  ],
  "createdAt": "2026-09-08T10:02:11.000Z",
  "updatedAt": "2026-09-08T10:02:11.000Z"
}