list_data_table_records - Qobra public API documentation

List one data table’s records, each column rendered human-readable. A data table is a company object table (deals, opportunities, accounts, custom objects…); a record is one row. Each record carries its id, its cell values, and record metadata: name (the table’s name column), source (origin), source_id (external system id), tag (status), active, created_at and last_modified_at. Cell values never expose raw ids — amounts carry their currency, dates are YYYY-MM-DD, picklists resolve to labels, user references to a structured {id, email, name} object and linked records to their name. A record’s values are positional against data_table.fields — the Nth value is the Nth field, so read that header to know a cell’s name and type. The column’s name and type are stated once there rather than repeated on every cell, which keeps a page of a wide table small. You only see tables and records you have access to; a table you can’t access is reported as not found. When a table reaches you through several shared views, pass view_id to pick which one. Rows are ordered most-recently-created first for local tables; for integration-synced tables they are ordered alphabetically by record name. The result carries a list-level application_url that reopens the exact list you just fetched — the table’s page with the chosen view selected. It is only set when a view was passed; otherwise it is null and the table’s own resource_url already opens the page.

Parameters

Body

string

required

Id of the table to read — the id list_data_tables returns for a customer-facing (local or integration) table.

string

Free-text filter, matched the same way as the records page — a case- and accent-insensitive substring of the record’s name and external id. Omitted returns the table’s records unfiltered. AND-ed with the applied view’s row filter.

string

Id of the view to narrow the records to, from the views of the table’s row in list_data_tables. Required only when several shared views reach the table.

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

object

Show object properties

string

Deep link to open this data table in the Qobra web app.

string

object

Show object properties

string

One of: kombo, salesforce, pipedrive, microsoft_dynamics, hubspot, odoo, zoho, attio, postgresql, gcp-postgresql, snowflake, snowflake-keys, redshift, microsoft-azure-sql, microsoft-azure-synapse, bigquery, s3, sftp, netsuite, public_api.

object[]

The views the caller may query for this table’s records — pass one’s id as view_id to list_data_table_records to narrow the rows. Empty when no view is relevant.

Show object properties

string

object[]

Show object properties

string

Stable technical key for this field in Qobra’s public API (use it as a durable reference; the display name can change).

string

Field data type: amount, percentage, float, string, bool, date, picklist, multipicklist, user, or object (a reference to another data table — see linked_to). One of: float, amount, percentage, string, picklist, multipicklist, bool, date, user, object, group, record_status.

object

When type is object, the table this field points to; null otherwise.

Show object properties

string

Name of the linked table. null when the caller has no access to the linked table (for example, when the link is visible only through a shared view on the current table). id is always returned.

object[]

Show object properties

string

Where the record comes from: integration (synced from a connected system) or local (created in Qobra). One of: integration, local, qobra, reporting.

string

The record’s id in its source system.

string

Integration record status (Created / Overwritten / Archived). Null for local-table records (no integration baseline) and for untouched integration rows.

boolean

string

object[]

The record’s cell values, one per column, in the same order as the enclosing result’s data_table.fields — read the Nth value against the Nth field to know its name and type. A cell carries only what varies per row (the value, plus its currency for an amount); the column’s name and type are stated once in that header rather than repeated on every cell.

Show object properties

any

string

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.

integer

string

Deep link that reproduces this list in the web app — the table’s page with the chosen view selected. Null when no view filter was applied (the table’s own resource_url already opens the page).

​Parameters

​Response

Parameters

Response