Get row

Get one row by identifier. Set includeRunState=true to attach the row's per-workflow-group run outcomes.

OAuth scope: api:read.

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

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/string?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"
  }
}
{
  "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
rowId*string

Unique table row identifier.

Length1 <= length

Query parameters

workspaceId*string

Workspace that owns the table.

Length1 <= length
includeRunState?boolean

Include per-workflow-group run outcomes on the row. Off by default. Run state above 2 MiB returns 413; omit this option to read the row without run state.

Response body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

GETGet table importGETGet view