STsteep
entities

POST /v1/entities/{entityId}/query

Query rows of an entity. Returns one object per row, keyed by property column. Use get entity by id first to learn which columns exist, then filter and sort by them.

Request

  • Base URL
    https://help.steep.app (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

entityIdstring required

entity.id — Unique resource ID (opaque).

Request body

limitinteger

Maximum number of rows to return. When the row limit is reached, response hasMore is true. For a more complete result, increase limit or narrow the result set with stricter filters.

Response

Response for status 200

cacheTtlInSecondsunknown required
sqlstring required
limitnumber required

The effective row limit applied to this query.

hasMoreboolean required

Indicates there is more data beyond the row limit.

dataobject[] required

Changes

No recorded changes to this operation across all 1 revision of this API.