Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsList Tenant Documents
Search the full API reference Esc to close

List Tenant Documents

Tenants · REST API reference

Get support
GET/v1/tenants/{tenant_id}/documents
Every document related to a tenant, not only the ones filed against the tenant row.

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/tenants/<TENANT_ID>/documents' \
  --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

tenant_idpath · stringrequired

Format: uuid

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

sortquery · string | null

Values: "created_at", "document_type", "document_date"

orderquery · string

Default: "desc" · Values: "asc", "desc"

document_typequery · string | null
documentable_typequery · string | null

Narrow the feed to documents filed against one kind of record. Omitted, every kind is returned.

Values: "tenant", "lease", "payment", "call_record", "communication"

Responses

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

200Successful Response
JSON · generated example
{
  "data": [
    {
      "belongs_to": {
        "lease_id": "00000000-0000-4000-8000-000000000001",
        "lease_number": "string",
        "lease_status": "string",
        "payment_id": "00000000-0000-4000-8000-000000000001",
        "payment_number": "string",
        "unit_id": "00000000-0000-4000-8000-000000000001",
        "unit_number": "string"
      },
      "created_at": "2026-10-29T12:00:00Z",
      "document_type": "string",
      "documentable_id": "00000000-0000-4000-8000-000000000001",
      "documentable_type": "string",
      "facility_id": "00000000-0000-4000-8000-000000000001",
      "format": "string",
      "id": "00000000-0000-4000-8000-000000000001",
      "mime_type": "string",
      "origin": "string",
      "updated_at": "2026-10-29T12:00:00Z",
      "file_size_bytes": 0
    }
  ],
  "meta": {
    "request_id": "string"
  },
  "pagination": {
    "has_more": false,
    "limit": 0,
    "cursor": "string",
    "total_count": 0
  },
  "metrics": {
    "cards": {},
    "computed_at": "2026-10-29T12:00:00Z",
    "is_stale": false,
    "scope": "facility"
  }
}

application/json

dataTenantDocumentResponse[]required
Show data schema
belongs_toDocumentOwnerResponserequired

What a document in a tenant's feed belongs to, so a list can label the row.

Show belongs_to schema
lease_idstring | null

The lease the document is filed against, when a lease owns it.

Format: uuid

Show lease_id schema
string | null

The lease the document is filed against, when a lease owns it.

Variant 1: string
string
Variant 2: null
null
lease_numberstring | null

Operator-facing reference of that lease.

Show lease_number schema
string | null

Operator-facing reference of that lease.

Variant 1: string
string
Variant 2: null
null
lease_statusstring | null

Lifecycle state of that lease, so a past lease's paperwork can be told from a current one's.

Show lease_status schema
string | null

Lifecycle state of that lease, so a past lease's paperwork can be told from a current one's.

Variant 1: string
string
Variant 2: null
null
payment_idstring | null

The payment the document is filed against, when a payment owns it (a receipt, an NSF notice).

Format: uuid

Show payment_id schema
string | null

The payment the document is filed against, when a payment owns it (a receipt, an NSF notice).

Variant 1: string
string
Variant 2: null
null
payment_numberstring | null

Operator-facing reference of that payment.

Show payment_number schema
string | null

Operator-facing reference of that payment.

Variant 1: string
string
Variant 2: null
null
unit_idstring | null

The unit that lease occupies.

Format: uuid

Show unit_id schema
string | null

The unit that lease occupies.

Variant 1: string
string
Variant 2: null
null
unit_numberstring | null

Operator-facing number of that unit.

Show unit_number schema
string | null

Operator-facing number of that unit.

Variant 1: string
string
Variant 2: null
null
created_atstringrequired

When the document record was created.

Format: date-time

document_typestringrequired

What the document is, for example a signed lease, an invoice, or an insurance certificate.

documentable_idstringrequired

Identifier of the record named by documentable_type.

Format: uuid

documentable_typestringrequired

The kind of record the document is attached to, for example a lease or a tenant.

facility_idstringrequired

The facility this document belongs to.

Format: uuid

file_size_bytesinteger | null

Size of the stored file in bytes.

Show file_size_bytes schema
integer | null

Size of the stored file in bytes.

Variant 1: integer
integer
Variant 2: null
null
formatstringrequired

Document format. Generated documents are PDF.

generated_atstring | null

When a generated document was rendered. On an imported document, the date the previous system recorded for it.

Format: date-time

Show generated_at schema
string | null

When a generated document was rendered. On an imported document, the date the previous system recorded for it.

Variant 1: string
string
Variant 2: null
null
idstringrequired

Unique identifier for this document.

Format: uuid

mime_typestringrequired

MIME type of the stored file.

originstringrequired

uploaded when a person uploaded the file, generated when a system produced it. Generated covers documents this platform rendered and documents carried over from a previous system by a data import; only the first kind has a template_version.

template_versionstring | null

Version of the template a generated document was rendered from, so an old document stays reproducible after the template changes. Null on an upload and on a document carried over by a data import.

Show template_version schema
string | null

Version of the template a generated document was rendered from, so an old document stays reproducible after the template changes. Null on an upload and on a document carried over by a data import.

Variant 1: string
string
Variant 2: null
null
titlestring | null

Display title of the document.

Show title schema
string | null

Display title of the document.

Variant 1: string
string
Variant 2: null
null
updated_atstringrequired

When the document record was last modified.

Format: date-time

uploaded_bystring | null

The user who uploaded the document, where a person did.

Format: uuid

Show uploaded_by schema
string | null

The user who uploaded the document, where a person did.

Variant 1: string
string
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
metricsEmbeddedMetrics | null
Show metrics schema
EmbeddedMetrics | null
Variant 1: EmbeddedMetrics
cardsobjectrequired
computed_atstring | nullrequired

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
is_stalebooleanrequired
scopestringrequired

Values: "facility", "portfolio"

Variant 2: null
null
paginationPaginationBlockrequired

Pagination metadata for list responses.

Show pagination schema
cursorstring | null
Show cursor schema
string | null
Variant 1: string
string
Variant 2: null
null
has_morebooleanrequired
limitintegerrequired
total_countinteger | null
Show total_count schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
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 tenants operations
Build something that works beautifully.

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

List Tenant Documents | Facily Developers