List Run Dispatches

List the run dispatches on one table, most recent first — settled dispatches (complete, canceled) alongside the ones still in flight, so a run that finished between two polls is still visible next to the dispatchId its create returned. Capped at the 100 most recent, so this list is unpaginated and nextCursor is always null.

OAuth scope: api:read.

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

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

Path Parameters

tableId*string

Unique table identifier.

Length1 <= length

Query Parameters

workspaceId*string

Workspace that owns the table.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.sim.ai/api/v2/tables/string/dispatches?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "string",
      "tableId": "string",
      "workspaceId": "string",
      "status": "pending",
      "mode": "all",
      "scope": {
        "groupIds": [
          "string"
        ],
        "rowIds": [
          "string"
        ],
        "filtered": true,
        "excludeRowIds": [
          "string"
        ]
      },
      "limit": {
        "type": "rows",
        "max": 1
      },
      "processedCount": 0,
      "isManualRun": true,
      "requestedAt": "2019-08-24T14:15:22Z",
      "completedAt": "2019-08-24T14:15:22Z",
      "canceledAt": "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": "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"
  }
}
GETGet ViewGETList Rows