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

Get Report Run Rows

Reports · REST API reference

Get support
GET/v1/report-runs/{run_id}/rows
One page of one stored table; the one GET that writes. The page is read first, then `report.viewed` is staged (once per run, actor, staff entry, API key and UTC day) and committed.

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/<RUN_ID>/rows?table=<TABLE>' \
  --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

run_idpath · stringrequired

The report run's id.

Format: uuid

tablequery · stringrequired

The stored table to read, as the run's detail lists it.

Min length: 1 · Max length: 80 · Pattern: ^_?[a-z][a-z0-9_]{0,78}$

pagequery · integer

The page, from 1. Page 1 also carries the table's totals.

Default: 1 · Minimum: 1

Responses

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

200Successful Response
JSON · generated example
{
  "data": {
    "page": 0,
    "pages": 0,
    "run_id": "00000000-0000-4000-8000-000000000001",
    "table": "string",
    "title": "string",
    "rows": [
      {}
    ],
    "totals": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataRowsPageResponserequired

One page of rows of one stored table.

Show data schema
pageintegerrequired

This page's number, from 1.

pagesintegerrequired

The table's pages.

rowsobject[]

The rows as stored, keyed by column. Money, percentages and decimal quantities are decimal strings; dates are ISO dates; times are ISO with the facility's offset. A subtotal or exception line carries `_kind`.

Show rows schema
object
run_idstringrequired

The run's id.

Format: uuid

tablestringrequired

The table's key.

titlestringrequired

The table's title.

totalsobject | null

The table's grand totals as decimal strings, on page 1 only.

Show totals schema
object | null

The table's grand totals as decimal strings, on page 1 only.

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

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

Get Report Run Rows | Facily Developers