Query rows with typed predicates, sorting, and cursor pagination. Omit the predicate to match all rows. Pages default to a 5 MB limit; continue until nextCursor is null. Oversized predicates return 413. includeRunState adds per-group outcomes and reduces the row limit. Counts are read separately and can differ from paged results if rows change.
OAuth scope: api:read.
/api/v2/tables/{tableId}/queryYour 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
Unique table identifier.
1 <= lengthRequest 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.
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/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
},
"runState": {
"property1": {
"status": "string",
"executionId": "string",
"workflowId": "string",
"error": "string",
"runningBlockIds": [
"string"
],
"blockErrors": {
"property1": "string",
"property2": "string"
},
"canceledAt": "2019-08-24T14:15:22Z"
},
"property2": {
"status": "string",
"executionId": "string",
"workflowId": "string",
"error": "string",
"runningBlockIds": [
"string"
],
"blockErrors": {
"property1": "string",
"property2": "string"
},
"canceledAt": "2019-08-24T14:15:22Z"
}
},
"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": "Authentication 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"
}
}