Skip to main content
List the frozen records of one compensation scope on a statement. A compensation calculates over one or more scopes (a data table filtered to a perimeter); each scope’s records are frozen into the statement at calculation time. This returns those snapshot records — the deals/rows that fed the commission — each with its displayable field values (amounts in the statement’s calculation currency, picklists as labels, user references as emails, linked records by name). This is the frozen snapshot, not the live data table (use list_data_table_records for the current data). Identify the statement by statement_id (from list_statements / get_statement), then name the compensation and its scope (discover both via get_statement / get_statement_compensation). A statement, compensation 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

​
compensation
string
required
The compensation whose scope to read, matched by name (case-insensitive substring, as shown in get_statement’s compensation lines) or by ObjectId.
​
scope
string
required
The scope to read within the compensation, matched by letter (A, B, …), by name (case-insensitive substring) or by ObjectId — as shown on the compensation’s scopes.
​
statement_id
string
required
The statement’s id, as returned by list_statements or get_statement.
​
search
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.
​
limit
integer
Page size, between 1 and 250. Defaults to 50.
​
offset
integer
Row offset into the result set — the number of rows to skip before this page. Pass the next_offset returned by the previous call, or None for the first page.

​
Response

Body

​
fields
object[]
The scope’s displayable columns (name + type), listed once for the whole page — each record’s values are keyed by these names.
​
calculation_currency
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.
​
records
object[]
​
next_offset
integer