Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Lease Agreement
Search the full API reference Esc to close

Get Lease Agreement

Leases · REST API reference

Get support
GET/v1/leases/{lease_id}/agreement
The lease's rental agreement rendered as a signer sees it, its SHA-256, the consent text, whether the facility's agreement is still Facily's sample, and the signing state with the newest remote request.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/leases/<LEASE_ID>/agreement' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

lease_idpath · stringrequired

Format: uuid

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "consent_text": "string",
    "consent_version": "string",
    "html": "string",
    "is_placeholder": false,
    "lease_id": "00000000-0000-4000-8000-000000000001",
    "sha256": "string",
    "signature_document_id": "00000000-0000-4000-8000-000000000001",
    "signature_method": "string",
    "signature_request": {
      "channel": "string",
      "expires_at": "2026-10-29T12:00:00Z",
      "id": "00000000-0000-4000-8000-000000000001",
      "last_reminder_at": "2026-10-29T12:00:00Z",
      "lease_id": "00000000-0000-4000-8000-000000000001",
      "reminder_count": 0,
      "sent_at": "2026-10-29T12:00:00Z",
      "signed_at": "2026-10-29T12:00:00Z",
      "status": "string"
    },
    "signed_at": "2026-10-29T12:00:00Z"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataLeaseAgreementResponserequired

The lease's rental agreement as a signer sees it, and its signing state.

Show data schema
consent_textstringrequired
consent_versionstringrequired
htmlstringrequired

The agreement, rendered for this lease.

is_placeholderbooleanrequired

The facility's agreement is still Facily's sample; accept and signing refuse it.

lease_idstringrequired

Format: uuid

sha256stringrequired

SHA-256 (hex) of `html`; a signature submits it as `seen_sha256`.

signature_document_idstring | nullrequired

The signed agreement's document.

Format: uuid

Show signature_document_id schema
string | null

The signed agreement's document.

Variant 1: string
string
Variant 2: null
null
signature_methodstring | nullrequired

in_person, paper, remote or storedge_import.

Show signature_method schema
string | null

in_person, paper, remote or storedge_import.

Variant 1: string
string
Variant 2: null
null
signature_requestSignatureRequestResponse | nullrequired

The newest remote request, if any.

Show signature_request schema
SignatureRequestResponse | null

The newest remote request, if any.

Variant 1: SignatureRequestResponse
channelstringrequired
expires_atstringrequired

Format: date-time

idstringrequired

Format: uuid

last_reminder_atstring | nullrequired

Format: date-time

Show last_reminder_at schema
string | null
Variant 1: string
Variant 2: null
lease_idstringrequired

Format: uuid

reminder_countintegerrequired
sent_atstring | nullrequired

Format: date-time

Show sent_at schema
string | null
Variant 1: string
Variant 2: null
signed_atstring | nullrequired

Format: date-time

Show signed_at schema
string | null
Variant 1: string
Variant 2: null
statusstringrequired

sent, viewed, signed, expired or revoked.

Variant 2: null
null
signed_atstring | nullrequired

Format: date-time

Show signed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll leases operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Get Lease Agreement | Facily Developers