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

List Report Runs

Reports · REST API reference

Get support
GET/v1/report-runs
The caller's runs and the runs delivered to them, newest first; for a Facily staff entry, the org's runs by every requester. No manifest and no figures. The switch is the context: no query parameter widens a member's list.

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/report-runs' \
  --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

GET requests only. Your key’s permissions and facility scope still apply.

Response
Your response will appear here.

Parameters

cursorquery · string | null

The `cursor` of the previous page; omit it for the first page.

limitquery · integer

Runs per page.

Default: 25 · Minimum: 1 · Maximum: 100

Responses

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

200Successful Response
JSON · generated example
{
  "data": [
    {
      "created_at": "2026-10-29T12:00:00Z",
      "date_basis": "string",
      "definition_key": "string",
      "expired": false,
      "has_notes": false,
      "id": "00000000-0000-4000-8000-000000000001",
      "requested_by": "00000000-0000-4000-8000-000000000001",
      "restricted": false,
      "status": "queued",
      "trigger": "manual",
      "view_key": "string",
      "as_of": "2026-10-29"
    }
  ],
  "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

dataRunListItem[]required
Show data schema
as_ofstring | null

The as-of date, for an as-of report.

Format: date

Show as_of schema
string | null

The as-of date, for an as-of report.

Variant 1: string
string
Variant 2: null
null
card_namestring | null

The report's name.

Show card_name schema
string | null

The report's name.

Variant 1: string
string
Variant 2: null
null
completed_atstring | null

When the run completed or failed.

Format: date-time

Show completed_at schema
string | null

When the run completed or failed.

Variant 1: string
string
Variant 2: null
null
created_atstringrequired

When the run was asked for.

Format: date-time

date_basisstringrequired

The date the run's view cuts on.

definition_keystringrequired

The report's key.

error_codestring | null

Why a failed run failed, as a code.

Show error_code schema
string | null

Why a failed run failed, as a code.

Variant 1: string
string
Variant 2: null
null
expiredbooleanrequired

True once the run's files are no longer offered.

expires_atstring | null

When the run's files stop being offered.

Format: date-time

Show expires_at schema
string | null

When the run's files stop being offered.

Variant 1: string
string
Variant 2: null
null
facility_idstring | null

The facility the run covers; null for all facilities.

Format: uuid

Show facility_id schema
string | null

The facility the run covers; null for all facilities.

Variant 1: string
string
Variant 2: null
null
filesReportRunFileResponse[]

The run's files.

Show files schema
detail_omittedbooleanrequired

True when the file prints the summary without its detail rows.

display_namestring | null

The name the file is saved under, once it is ready.

Show display_name schema
string | null

The name the file is saved under, once it is ready.

Variant 1: string
string
Variant 2: null
null
formatstringrequired

The file's format.

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

messagestring | null

Why a file is unavailable, failed, or prints totals only, for the reader.

Show message schema
string | null

Why a file is unavailable, failed, or prints totals only, for the reader.

Variant 1: string
string
Variant 2: null
null
reasonstring | null

Why a file failed or is unavailable, as a code.

Show reason schema
string | null

Why a file failed or is unavailable, as a code.

Variant 1: string
string
Variant 2: null
null
size_bytesinteger | null

The file's size, once it is ready.

Show size_bytes schema
integer | null

The file's size, once it is ready.

Variant 1: integer
integer
Variant 2: null
null
statusstringrequired

`queued` while it is prepared, `ready` to download, `failed` or `unavailable` when it cannot be.

Values: "queued", "ready", "failed", "unavailable"

has_notesbooleanrequired

True when the run carries notes for the reader.

idstringrequired

The run's id.

Format: uuid

period_endstring | null

The last day of the period, for a period report.

Format: date

Show period_end schema
string | null

The last day of the period, for a period report.

Variant 1: string
string
Variant 2: null
null
period_startstring | null

The first day of the period, for a period report.

Format: date

Show period_start schema
string | null

The first day of the period, for a period report.

Variant 1: string
string
Variant 2: null
null
requested_bystringrequired

The member who asked for the run.

Format: uuid

restrictedbooleanrequired

True when the run stored restricted columns unmasked.

row_countinteger | null

Detail rows the run holds, once completed.

Show row_count schema
integer | null

Detail rows the run holds, once completed.

Variant 1: integer
integer
Variant 2: null
null
statusstringrequired

`queued`, `running`, `completed` or `failed`.

Values: "queued", "running", "completed", "failed"

triggerstringrequired

`manual`, or `schedule` for a scheduled run.

Values: "manual", "schedule"

view_keystringrequired

The view's key.

view_namestring | null

The view's name.

Show view_name schema
string | null

The view's name.

Variant 1: string
string
Variant 2: null
null
weakest_verdictstring | null

The least certain history mark of any column of the run, once completed.

Values: "observed", "rebuilt", "approximate", "shallow"

Show weakest_verdict schema
string | null

The least certain history mark of any column of the run, once completed.

Variant 1: string
string

Values: "observed", "rebuilt", "approximate", "shallow"

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

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

List Report Runs | Facily Developers