{id, email, name} objects, linked records by name). This is the frozen snapshot, not the
live data table (use list_data_table_records for the current data).
A record’s values are positional against the result’s fields — the
Nth value is the Nth column, so read that header to know a cell’s name and type.
The column’s name and type are stated once there, and the shared
calculation_currency once at the result level, rather than repeated on every
cell. A column a record has no value for holds a null, so every row is the same
width as the header.
Identify the statement by statement_id (from list_statements /
get_statement) and the scope by scope_id (from
get_statement_compensation’s scopes). A scope belongs to exactly one
compensation, so its id is enough — there is no compensation argument.
A statement or scope you can’t access reads exactly like one that doesn’t exist,
so the error never reveals anything outside your scope.
Records keep the statement’s frozen scope order — the index they were
snapshotted in at calculation time.
Parameters
Body
Body
string
required
Id of the statement the scope was frozen into — the id list_statements or
get_statement returns.
string
required
Id of the scope to read, from the
id of one of
get_statement_compensation’s scopes.string
Free-text filter, a case-insensitive substring matched against each record’s
text and linked-record name fields. Omitted returns the scope’s records
unfiltered.
integer
Page size, between 1 and 250. Defaults to 50.
integer
Row offset into the result set — the number of rows to skip before this
page. Any offset >= 0 is accepted; it does not have to be a multiple of
limit, so you can start from an arbitrary row. Pass the next_offset returned
by the previous call to walk the pages, or None for the first page.
Response
Body
Body
object[]
The scope’s displayable columns (name + type), listed once for the whole
page — each record’s
values align positionally against this list (the Nth
value belongs to the Nth field).string
The currency every AMOUNT value in the records is in. One of:
AED, AFN,
ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT,
BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP,
BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, COU, CRC,
CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB,
EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD,
HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK,
JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD,
KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL,
MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR,
MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK,
PHP, PKR, PLN, PYG, QAR, RMB, RON, RSD, RUB, RWF, SAR,
SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC,
SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS,
UAH, UGX, USD, UYI, UYU, UZS, VEF, VND, VUV, WON, WST,
XAF, XAG, XAU, XCD, XOF, XPD, XPF, XPT, XSU, YER, ZAR,
ZMK, ZWL.object[]
integer