Skip to content
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 rendered and signed itself, docuseal for one created in the organisation’s DocuSeal account, guesty for a record imported from Guesty. Each envelope keeps the provider it was issued with. "quarters""docuseal""guesty"
externalId string | nullThe DocuSeal submission id, or the Guesty reservation id; null for a Quarters envelope.
status enum "sent""completed""declined""failed""voided"
templateName string | nullThe Quarters template used; null for a DocuSeal 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’s own copy of the executed document, where it keeps a lasting link. Null for DocuSeal, whose links expire within the hour.
document object | nullSet once the executed PDF has been archived in Quarters: sealed at signing for its own envelopes, fetched from DocuSeal for those.
signers Signer[]
createdAt timestamp ISO 8601
updatedAt timestamp ISO 8601

Used by

Example

{
  "id": "9a41…",
  "version": 1,
  "provider": "docuseal",
  "externalId": "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": "Acme Stays B.V.",
      "email": "hello@example.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"
}