Skip to main content
GET/extensions-admin/{slug}/tables/{table}/rows

List Extension Table Rows

Lists the rows of one of an installed extension's own tables, a page at a time. order is created_at or updated_at (the default) and dir is asc or desc (the default); the row id breaks ties, so every row appears once across pages.

Pass the returned cursor to read the next page; it is null on the last page.

limit defaults to 100, and a value above 1000 reads 1000.

Timestamps come back as ISO 8601 with an offset, to the microsecond.

Reads are not written to the audit log.

Only a signed-in operator reaches it: a plugin token, a personal access token, a service token and an end user are refused.

The caller needs a project membership; an org role alone gets nothing here.

The table must be one the installed version's manifest lists in schema.user_tables, and the caller's project role must be in the set its min_role names: PROJECT_ANALYST admits analysts, editors, authors and admins, never an auditor alone.

Parameters
projectSlug *path

The project's slug.

slug *path

The installed extension's slug.

table *path

A table the extension's manifest lists in schema.user_tables.

limitquery

The page size, an integer from 1.

Default 100; a larger value than 1000 reads as 1000.

cursorquery

The cursor the previous page returned.

orderquery

created_at or updated_at (the default).

dirquery

asc or desc (the default).

Responses
HTTPK9O CodeDescription
200Success
400K9O_INVALID_FIELD_VALUE`limit` is not a positive integer, `order` is not created_at or updated_at, `dir` is not asc or desc, or `cursor` is not one this route returned.
401K9O_UNAUTHENTICATEDThe caller is not signed in.
403K9O_FORBIDDENThe caller is not an operator session (`context.reason: "principal_not_admitted"`), or their project role is not in the table's `min_role` set (`context.reason: "below_min_role"`, `context.minRole`).
403K9O_ACCESS_DENIEDThe caller has no membership in this project; an org role alone does not count.
403K9O_IAM_POLICY_DENIEDA bound IAM policy denies extensions:table_read or extensions:table_write on this extension.
403K9O_EXTENSION_DISABLEDThe extension is installed but not enabled.
404K9O_EXTENSION_NOT_INSTALLEDNo extension with this slug is installed on the project.
404K9O_EXTENSION_TABLE_NOT_FOUNDThe extension has no user table by this name: it is not in the manifest's `schema.user_tables`, or it does not exist. Both answer the same.
409K9O_STATE_CONFLICTThe table does not have the user-table shape (`context.reason: "user_table_shape"`, `context.column`): an `id text` primary key, `created_by text NOT NULL`, and `created_at` and `updated_at` `timestamptz NOT NULL`.
429K9O_EXTENSION_BFF_RATE_LIMITEDToo many calls from this caller to this extension; retry after a second.
Response body (200)
data *object

One page of rows and the cursor for the next.

rows *object[]

One page of rows, in the order asked for, with the row id as the tiebreak.

cursor *any

Pass it as cursor to read the next page.

It is null on the last page.

One of: string
or: null
meta *any
cURL
curl -X GET 'https://<org>.api-<region>.k9o.io/@storefront/extensions-admin/demoext/tables/<table>/rows' \
  -H 'Authorization: Bearer $K9O_TOKEN'

Showing example in cURL

Response example (200)
{
  "data": {
    "rows": [],
    "cursor": "string"
  }
}

More in Extensions