Get an operation
Read durable status, result, or safe failure details.
API 2.7.0 · Published service contract ↗
Request
Base URL: https://app.sym.so/v1/workspaces/{workspace_id}
Authentication: bearer. Required scope: operations:read.
GET /operations/{operation_id}
Read durable status, result, or safe failure details.
| Parameter | Type | Description |
|---|---|---|
operation_idpath · required | string | Required operation_id path identifier. |
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/operations/$OPERATION_ID" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"{
"worker_id": "worker-example-001",
"org_id": "workspace_example",
"item": {
"id": "op_01J8",
"operation_type": "message.send",
"status": "succeeded",
"result": {
"message_id": "msg_01JA",
"dispatched": true
},
"error": null
},
"ok": true
}Authorization
{
"type": "bearer",
"scope": "operations:read",
"transport": "Authorization: Bearer <workspace_api_key>"
}Errors
| Status | Description |
|---|---|
| 401 | The workspace API key is missing, invalid, expired, or revoked. |
| 403 | The key lacks the required scope or its owner no longer has permission. |
| 404 | The resource is missing or intentionally hidden by authorization. |
| 429 | The key exceeded its current rate limit. |