List rows

List rows in default order with cursor pagination. Pages default to a 5 MiB limit and may contain fewer rows than requested; continue until nextCursor is null. Use Query rows for filtering and sorting. includeRunState=true adds per-group run outcomes and reduces the row limit.

OAuth scope: api:read.

GET/api/v2/tables/{tableId}/rows

Authorization

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

Request examples use an API key. For OAuth, replace the X-API-Key header with Authorization: Bearer YOUR_ACCESS_TOKEN.

curl -X GET "https://www.sim.ai/api/v2/tables/string/rows?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "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": "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"
  }
}

Path parameters

tableId*string

Unique table identifier.

Length1 <= length

Query parameters

workspaceId*string

Workspace that owns the table.

Length1 <= length <= 128
limit?integer

Maximum rows to return per page. Must be a whole number from 1 to 1000. Defaults to 100.

Default100
Range1 <= value <= 1000
cursor?string

Opaque cursor from the previous page. Send it back with the same sort and filters; only limit may change. Change anything else and pagination must restart without a cursor.

Length1 <= length
includeRunState?boolean

Include per-workflow-group run outcomes on every row. Off by default. Caps limit at 200. Run state above 2 MiB returns 413; request fewer rows or omit run state.

Response body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

GETList run dispatchesGETList tables