Skip to navigation

List tables

View as Markdown

List the tables SQL queries can target, without their columns.

Returns each table’s name, semantic category, description, column count, and the tables its foreign keys reference: the org’s own tables first, then the platform tables (core_experiment, core_instrument, and similar), whose descriptions are cut to one line. Call this first to find the tables a task needs and how they join, then pass their names to get_schema for the columns.

Requires an API key with the read scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

OK
namestring

Pass this to get_schema to read the columns.

column_countinteger
referenceslist of strings
Names of the tables this table's foreign keys point to.
semantic_categorystring or nullOptional
descriptionstring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error