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

Get Report Catalog

Reports · REST API reference

Get support
GET/v1/facilities/{facility_id}/reports
The report library for one facility, or for `all`: every card and view, locked ones included.

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/facilities/<FACILITY_ID>/reports' \
  --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

facility_idpath · string | stringrequired

Format: uuid

Responses

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

200Successful Response
JSON · generated example
{
  "data": {
    "limits": {
      "max_period_days": 0,
      "max_recipients": 0,
      "max_rows": 0
    },
    "cards": [
      {
        "availability": {
          "state": "available",
          "lock": {
            "code": "string",
            "label": "string",
            "message": "string",
            "type": "step"
          },
          "locks": [
            {
              "code": "string",
              "label": "string",
              "message": "string",
              "type": "step"
            }
          ]
        },
        "category": "string",
        "contains_personal_data": false,
        "description": "string",
        "key": "string",
        "name": "string",
        "permission": {
          "key": "string",
          "label": "string"
        },
        "schedulable": false,
        "scope": "facility",
        "user": {
          "favorite": false,
          "run_count": 0,
          "last_run_at": "2026-10-29T12:00:00Z"
        },
        "advisories": [
          {
            "code": "string",
            "message": "string"
          }
        ],
        "coverage": {
          "family": "string",
          "from": "2026-10-29",
          "snapshot_from": "2026-10-29"
        }
      }
    ],
    "categories": [
      {
        "key": "string",
        "label": "string"
      }
    ],
    "features": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataReportCatalogResponserequired

The report library for one scope (framework 11.3): every card and view, locked ones included.

Show data schema
cardsCardResponse[]

Every card, in group order.

Show cards schema
advisoriesAdvisoryResponse[]

Each advisory that applies at the facility or facilities asked for.

Show advisories schema
codestringrequired

`import_maintained`, `not_cut_over`, `delinquency_not_activated`, `coverage_pending` or `history_not_built`.

messagestringrequired

The advisory's fixed sentence. It names no facility.

availabilityReportAvailabilityResponserequired

Whether a card or a view can run, and every lock that stands in the way (framework 11.3).

Show availability schema
lockLockResponse | null

The first applicable lock, the one the page shows.

Show lock schema
LockResponse | null

The first applicable lock, the one the page shows.

Variant 1: LockResponse
Variant 2: null
locksLockResponse[]

The other applicable locks, in order: step, plan, permission.

Show locks schema
codestringrequired

What a client keys on: a capability key or `builder_pending` for a step lock, `plan_gate_<feature>` for a plan lock, the card's permission for a permission lock.

labelstringrequired

A short name for what is missing.

messagestringrequired

One sentence for the reader. It names no facility.

typestringrequired

`step`: a capability Facily has not shipped, or a report not built yet. `plan`: the organization's plan lacks the feature. `permission`: the caller may not run it at this scope. Locks are evaluated and listed in that order.

Values: "step", "plan", "permission"

statestringrequired

`available`; `available_locked_columns`, which runs without its locked columns and rows; or `locked`. A card is locked when it is, or when every one of its views is.

Values: "available", "available_locked_columns", "locked"

categorystringrequired

The key of its group.

contains_personal_databooleanrequired

True when a column of the card is personal or restricted.

coverageReportCoverageResponse | null

How far back its history goes; null for a card bounded by no family.

Show coverage schema
ReportCoverageResponse | null

How far back its history goes; null for a card bounded by no family.

Variant 1: ReportCoverageResponse
familystringrequired

The coverage family that bounds the card.

fromstring | null

The family's floor: the first date it holds data for. For all facilities, the earliest floor among them. Null when no facility in scope has data for it.

Format: date

snapshot_fromstring | null

A second bound the catalog service gives for some cards; null when it gives none.

Format: date

Variant 2: null
null
descriptionstringrequired

One sentence on what the card holds.

filtersFilterResponse[]

Its filters; empty on a stub.

Show filters schema
defaultstring | null

A single-choice enum filter's starting value, the card's own default for it: the dialog opens the filter on it and offers no 'Any'. Null for every other filter, which starts unset.

Show default schema
string | null

A single-choice enum filter's starting value, the card's own default for it: the dialog opens the filter on it and offers no 'Any'. Null for every other filter, which starts unset.

Variant 1: string
Variant 2: null
keystringrequired

The filter's key in a run's `filters`.

kindstringrequired

How the dialog renders it and how create validates it.

Values: "enum", "boolean", "date", "number", "money", "entity"

labelstringrequired

The filter's display name.

maximumstring | null

A number or money filter's inclusive upper bound, as a decimal string.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show maximum schema
string | null

A number or money filter's inclusive upper bound, as a decimal string.

Variant 1: string
Variant 2: null
minimumstring | null

A number or money filter's inclusive lower bound, as a decimal string.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show minimum schema
string | null

A number or money filter's inclusive lower bound, as a decimal string.

Variant 1: string
Variant 2: null
multiplebooleanrequired

An enum or entity filter that takes a list.

optionsobject[][]

An enum filter's choices, as `[value, label]` pairs.

Show options schema
object[]
sourcestring | null

An entity filter's picker.

Values: "unit_type", "unit_group", "unit", "tenant", "lease", "promotion", "insurance_plan", "revenue_rule", "rent_raise_batch", "delinquency_case"

Show source schema
string | null

An entity filter's picker.

Variant 1: string
Variant 2: null
formatsstring[]

The file formats a run of the card produces.

Show formats schema
string

Values: "csv", "xlsx", "pdf", "zip"

keystringrequired

The card's permanent key.

namestringrequired

The card's name.

permissionReportPermissionResponserequired

The permission a card needs, with `facility.read`, at the scope it runs for (framework 10.1).

Show permission schema
keystringrequired

The permission string, for example `report.financial`.

labelstringrequired

Its display name.

schedulablebooleanrequired

Whether the card can ever be scheduled.

scopestringrequired

`facility` (one facility or all), `org_only` (all facilities only) or `either`.

Values: "facility", "org_only", "either"

userReportUserStateResponserequired

The caller's own use of a card (framework 14).

Show user schema
favoritebooleanrequired

True when the caller starred the card.

last_run_atstring | null

When the caller last created a manual run of the card.

Format: date-time

Show last_run_at schema
string | null

When the caller last created a manual run of the card.

Variant 1: string
Variant 2: null
run_countintegerrequired

How many manual runs of the card, any view, the caller has created.

viewsViewResponse[]

Its views; the first is the default.

Show views schema
aliasesstring[]

Other names the search box matches.

Show aliases schema
string
availabilityReportAvailabilityResponserequired

Whether a card or a view can run, and every lock that stands in the way (framework 11.3).

Show availability schema
lockLockResponse | null

The first applicable lock, the one the page shows.

locksLockResponse[]

The other applicable locks, in order: step, plan, permission.

statestringrequired

`available`; `available_locked_columns`, which runs without its locked columns and rows; or `locked`. A card is locked when it is, or when every one of its views is.

Values: "available", "available_locked_columns", "locked"

date_basisReportDateBasisResponserequired

The one date basis a view cuts on (framework 4.4).

Show date_basis schema
keystringrequired

The basis.

Values: "effective", "posted", "settled", "event", "recorded", "state"

labelstringrequired

Its display name.

fixed_filtersstring[]required

The filters this view fixes; the dialog hides them. Each is a key of the card's `filters`, sorted, and a value sent for one is ignored: the view's own value applies.

Show fixed_filters schema
string
has_restricted_columnsbooleanrequired

True when the view prints a restricted column, masked unless the run asks otherwise.

keystringrequired

The view's permanent key, unique across the library; a run is created for it.

kindstringrequired

`as_of`, `period`, `roll` or `tenant_document`: which dates a run of it takes.

Values: "as_of", "period", "roll", "tenant_document"

max_period_daysinteger | null

The longest period a run accepts; null when the card relies on the row limit.

Show max_period_days schema
integer | null

The longest period a run accepts; null when the card relies on the row limit.

Variant 1: integer
Variant 2: null
namestringrequired

The view's name.

storedge_namestring | null

The name this report had in the management system the organization used before, if any.

Show storedge_name schema
string | null

The name this report had in the management system the organization used before, if any.

Variant 1: string
Variant 2: null
tablesTableResponse[]

Its tables; empty on a stub.

Show tables schema
columnsColumnResponse[]

Its columns, in output order.

keystringrequired

The table's key, the `table` a rows page asks for.

locked_rowsLockedRowResponse[]

Its labelled rows that are locked, absent from every output.

titlestringrequired

The table's title.

categoriesCategoryResponse[]

The groups, in display order.

Show categories schema
keystringrequired

The group's permanent key.

labelstringrequired

The group's name.

featuresobject

`ai_custom_reports`, `drive_delivery` and `scheduling`, each locked or available.

limitsReportLimitsResponserequired

Limits the page states before a run (framework 7.8).

Show limits schema
max_period_daysintegerrequired

The longest period a card accepts unless it declares its own.

max_recipientsintegerrequired

The most recipients one schedule may name.

max_rowsintegerrequired

A run with more rows than this is refused, never truncated.

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 reports operations
Build something that works beautifully.

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

Get Report Catalog | Facily Developers