Leases
Documents
PDF

List lease PDFs

Retrieves the list of all generated PDFs for a specific lease

get/leases/{lease_id}/pdfs

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/pdfs
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

Unique lease ID

Response

PDF list retrieved successfully

idstring uuid required

Unique identifier of the generated PDF

lease_idstring uuid required

Associated lease ID

template_idstring uuid required

Template ID used

template_type'LeaseContract' | 'Amendment' | 'InventoryReport' | 'RentReceipt' | 'NoticeToVacate' | 'OtherDocument' required

Template type used

file_pathstring required

Path or URL of the generated PDF file

file_sizeinteger required

File size in bytes

creation_timestampstring date-time required

PDF creation date and time

custom_variablesobject nullable

Custom variables used during generation

Example response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "lease_id": "550e8400-e29b-41d4-a716-446655440001",
    "template_id": "550e8400-e29b-41d4-a716-446655440002",
    "template_type": "LeaseContract",
    "file_path": "https://storage.example.com/pdfs/lease_contract_123.pdf",
    "file_size": 524288,
    "creation_timestamp": "2024-01-15T10:30:00Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.