List table records

get

https://app.hive.com/api/v2/workspaces/{workspaceId}/tables/{tableId}/records

Lists the records of a table as flat rows for reporting tools such as Power BI, Excel and Tableau. Each node has _id, _createdAt and _modifiedAt, plus one property for each active field, keyed by field key. Every row has every field, with null for an empty cell. Select cells show option labels. A cell with more than one value (options, users, linked records) is one string, joined with ", ". To get the next page, send pageInfo.endCursor as after, or send offset.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

workspaceId

string

required

Workspace ID.

tableId

string

required

Table ID, from List tables.

Query Params

first

integer

1 to 200

Number of records in the page. Default 50.

offset

integer

≥ 0

Number of records to skip from the start. Do not combine with after.

after

string

pageInfo.endCursor from the previous page. Do not combine with offset.

filter

string

JSON array of conditions that all must match, for example [{"key":"capacity","operator":"gt","value":{"number":3}}]. Operators: equals, notEquals, contains, notContains, gt, gte, lt, lte, isEmpty, isNotEmpty, anyOf, notAnyOf. The value has one property for the field type, for example text, number, boolean, date, optionIds or userIds.

string

Text to find in the record's cells.

sort

string

JSON array of sort keys, for example [{"key":"capacity","dir":"desc"}].

total_count

boolean

When true, include totalCount in pageInfo.

Responses

403

Forbidden

404

Not Found

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200One page of records

400Bad Request