WeaveKit Docs

List records

Returns one page of records. Row scope (`all`/`own`/`team`), field exclusions and sensitive-field masking follow the identity's RBAC.

GET/api/objects/{name}

Returns one page of records. Row scope (all/own/team), field exclusions and sensitive-field masking follow the identity's RBAC.

Authorization

bearerAuth
AuthorizationBearer <token>

API key present in auth.source (or resolved by an AuthResolver).

In: header

Path Parameters

name*string

Object name from objects/<name>/schema.json.

Query Parameters

filter?string

URL-encoded JSON object of field filters.

sort?string

Comma-separated field:direction pairs.

fields?string

Comma-separated field projection.

limit?integer

Page size.

Range1 <= value
offset?integer

Rows to skip.

Range0 <= value
total?string

How total is computed: exact (default, COUNT), estimate (pg_class.reltuples, approximate) or none (omit total).

Value in

  • "exact"
  • "estimate"
  • "none"

Response Body

application/json

application/json

curl -X GET "https://example.com/api/objects/string?filter=%7B%22status%22%3A%22open%22%7D&sort=created_at%3Adesc&fields=id%2Ctitle"
{  "rows": [    {}  ],  "total": 0,  "limit": 0,  "offset": 0}