Get Run Dispatch

Poll one workflow-column run dispatch by the dispatchId the run endpoints returned. Answers in every lifecycle state — pending, dispatching, complete, and canceled — so a poller can wait for a run to settle. Per-cell outcomes are read with includeRunState on the row endpoints.

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

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
dispatchId*string

Unique table run-dispatch identifier.

Length1 <= length

Query Parameters

workspaceId*string

Workspace that owns the transfer resource.

Length1 <= length <= 128

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