list_data_tables - Qobra public API documentation

List your company’s data tables and their fields, with filters and pagination. Only local and integration-synced tables are returned. Each table carries its source, its public-API key, the integration it syncs from for integration tables, and its fields. Every field carries its public-API key in <origin>.<key> form, its data type and — for a link field pointing at another table — that table’s id and name. You only see the data tables you have access to. Rows are ordered alphabetically by table name (A→Z).

Parameters

Body

string

Filter matched against the table name (case- and accent-insensitive substring) or, when it is a valid ObjectId, against the table id.

string

Filter restricting results to local or integration tables. Omit to return both kinds.

string

Keep only tables synced from the integration with this id — the id list_integrations returns. Local tables have no integration, so this excludes them.

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.

integer

​Parameters

​Response

Parameters

Response