Skip to main content
GET
Read report worksheet rows

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

id
integer
required

Record ID within the organization and any parent resource in this route.

Query Parameters

page
integer
default:1

Page.

Required range: x >= 1
limit
integer
default:25

Rows per page; per_page is a compatibility alias.

Required range: 1 <= x <= 100

Search.

Maximum string length: 1000
group
string

Optional groupable field key.

range
string

Runtime date preset, or custom_range with start and end.

start
string<date>

Start.

end
string<date>

End.

sort
string

Runtime field key and optional direction, such as created_at:desc.

include_rollups
boolean

Include aggregate rollups and groups with worksheet rows.

columns
string[]

Optional runtime column keys permitted by the report field catalog.

filterGroups
object[] | null

Optional runtime filters, validated against source and field access. Field/operator/value filters validated against the chosen module, context and operator capabilities. filterGroups takes precedence over fields.

filter_groups_provided
boolean

Use true with no filterGroups to explicitly clear saved runtime filters.

Response

Read report worksheet rows response.

data
object