Search Rows

Text-search every cell case-insensitively for the substring q, optionally within a predicate-filtered and sorted view. This is TEXT search, not the structured predicate read: POST /api/v2/tables/{tableId}/query is that one, and on this surface query always means a structured predicate while search always means text.

It returns cell COORDINATES — { ordinal, rowId, column } — and never row data. ordinal is the row's zero-based index in the same filtered, sorted view POST /query pages, so read the rows themselves through that. The result is uncursored and capped: at most 1000 matches come back and truncated is true when more matched than were returned. There is no cursor to page with — narrow q or the predicate instead.

POST/api/v2/tables/{tableId}/rows/search

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, substring query, and optional predicate and sort.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://www.sim.ai/api/v2/tables/string/rows/search" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "q": "acme",    "predicate": {      "all": [        {          "field": "status",          "op": "eq",          "value": "active"        }      ]    }  }'
{
  "data": {
    "matches": [
      {
        "ordinal": 0,
        "rowId": "string",
        "column": "string"
      }
    ],
    "truncated": true
  }
}
{
  "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": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Request body must be sent as application/json"
  }
}
{
  "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"
  }
}