Skip to main content
Get one data table’s field schema, by its id: the same shape as a list_data_tables row, plus its fields. Each field carries its type, its own key, default and currency_key, the linked table’s id and name for a link field, and for a picklist / multipicklist field its options, the exact labels to write. The table’s adjustment_reasons come with them. Use list_data_tables to discover which tables exist and find a table’s id from its name. You only see the data tables you have access to. A table id seen elsewhere (the source table of a report, the link of a record) can be out of your access or not a customer table, and then reads “not found” like an unknown id: don’t retry it. Each view’s access says who can read it when you may share the table; null means that is not yours to see, never that nobody reads it.

Parameters

Body

string
required
Id of the data table, from list_data_tables.

Response

Body

string
The id to pass to tools that take one.
string
Deep link to open this data table in the Qobra web app.
string
string
Stable key in Qobra’s public API, for your own tooling (a display name can change). Never an identifier here — pass id instead.
string
object
object[]
The views you may query this table’s records through: pass one’s id as view_id to list_data_table_records. Empty when none is relevant.
object[]
string[]
The reasons a manual edit of this table’s records must cite, passed as reason to create_record / update_record / split_record; null when an edit here needs none.