List Reference Tables

List reference tables readable by the authenticated organization.

Returns your organization's tables plus published Nebulock-curated ones. Retired
(soft-deleted) tables are never returned.

items is omitted by default -- loading every row of every table to render a
page is the cost this shape avoids. Two counts describe the size without them:
entry_count is how many (field_name, value) entries the table carries, and
item_count is how many rows hold them. They differ whenever a row covers more than
one field, which is every multi-column CSV upload.

include_items=true loads them anyway, in one query for the whole page. Ask for it
knowingly: a table holds up to 2,500 entries, so a full page of large tables is a very
large response. Pair it with a smaller limit, or fetch the one table you need.

slug matches exactly, which search does not: a search for browsers also
returns a table that merely mentions it in a description, so it cannot answer "which
table does ref_table('browsers') mean". Case-sensitive, and stored slugs are always
lowercase, so a capitalised value matches nothing rather than guessing. Both filters
may be combined.

A slug lookup can return two tables: your own and a published Nebulock-curated one
may share an unprefixed name, and you can read both. Your own sorts first, so
data[0] is the table ref_table('<slug>') would expand to -- the same precedence
expansion applies. That ordering outranks order_by for a slug lookup, and only for
one; add &type=customer or &type=nebulock to see just one side.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 1000
Defaults to 100

Maximum number of reference tables to return

integer
≥ 0
Defaults to 0

Number of reference tables to skip

string
Defaults to updated_at

One of: title, slug, entry_count, item_count, created_at, updated_at

string
Defaults to desc

Order direction (asc/desc)

Keyword search across title, slug and description

Exact slug match, as written in ref_table('...')

enum

Filter by ownership: nebulock or customer


Who owns a reference table. Derived from organization_id, never stored.

The draft spec also listed baseline; it is deliberately not here, because nothing
we store distinguishes it from nebulock. It can be added once something does.

enum

Filter by publish state


Publish state of a portal-owned table.

Only meaningful for tables owned by the internal portal org; a customer-owned table
carries None, which means "not applicable" rather than "private". A tenant table
is always and only visible to its own org, and there is no state that changes that.

Exclude tables last updated before this time

Exclude tables last updated after this time

boolean
Defaults to false

Include your organization's rules that use each table

boolean
Defaults to false

Include every item row of each table on the page

Headers
string
required

Your API Key ID

string

Your API Key Secret

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json