Query Rows

Query rows with an optional typed predicate, ordered sort specification, and opaque cursor pagination. A predicate may be one condition or an all/any group; omit it to match every row. Bounded pages are capped at 5MB by default and may contain fewer rows than the requested limit; continue until nextCursor is null. A predicate larger than the request-body ceiling is a 413.

POST/api/v2/tables/{tableId}/query

Authorization

apiKey

X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Path Parameters

tableId*string

Unique table identifier.

Length1 <= length

Request Body

application/json

Workspace scope, optional predicate and sort, and cursor pagination controls. The predicate may be one condition or an all/any group; omitting it matches every row.

TypeScript Definitions

Use the request body type in TypeScript.

workspaceId*string

Unique workspace identifier.

Length1 <= length <= 128

predicate?||

A single { field, op, value } condition or a recursive all/any group; either form is normalized to a grouped predicate after validation. At most 100 members per group, 10 levels of nesting, and 500 nodes in total. The negating operators include nulls: ne, nin, ncontains, nlike, and nilike match rows whose column is null or absent, so "not X" is not the complement of "X" over a nullable column. That holds for every column type, multi-select included. To exclude nulls, all-combine the negation with isNotEmpty (multi-select) or isNotNull. Comparison: eq, ne, gt, gte, lt, lte. Membership: in, nin (array operand). Emptiness: isEmpty, isNotEmpty, isNull, isNotNull (no operand). Substring, always case-insensitive, operand matched literally: contains, ncontains, startsWith, endsWith. Pattern: like/nlike (case-sensitive), ilike/nilike (case-insensitive). * is the only wildcard and stands for any run of characters; %, _, and backslash match themselves. Use like: "Hi*", not like: "Hi%". A select column compares by option id and restricts its operators: single-select accepts eq, ne, in, nin; multi-select accepts contains, ncontains. Option names are accepted as operands and resolved to ids.

sort?array<>

Ordered table-row sort specification.

Itemsitems <= 16

limit?integer

Maximum rows to return; zero requests an unbounded result.

Range0 <= value <= 1000

cursor?string

Opaque cursor returned by the previous query page.

Length1 <= length

Response Body

`application/json`

curl -X POST "https://www.sim.ai/api/v2/tables/string/query" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "string"  }'

{
  "data": [
    {
      "id": "string",
      "data": {
        "email": "jane@example.com",
        "name": "Jane Doe",
        "age": 30
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextCursor": "string"
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}

{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}

{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

413application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`