SymDocs
Workspace API
All productsSym Workspace APISym Passes MCP
Supportjoinsym.com ↗
Sym Workspace API

Get message status

Poll one durable message until it completes or fails.

API 2.7.0 · Published service contract ↗

Request

Base URL: https://app.sym.so/v1/workspaces/{workspace_id}

Authentication: bearer. Required scope: messages:read.

GET /messages/{message_id}

Poll one durable message until it completes or fails.

ParameterTypeDescription
message_id
path · required
stringDurable message ID.
Request
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/messages/$MESSAGE_ID" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "message": {
    "id": "msg_01JA",
    "role": "user",
    "status": "completed",
    "responded_at": "2026-08-04T10:31:12Z"
  },
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "messages:read",
  "transport": "Authorization: Bearer <workspace_api_key>"
}

Errors

StatusDescription
401The workspace API key is missing, invalid, expired, or revoked.
403The key lacks the required scope or its owner no longer has permission.
404The resource is missing or intentionally hidden by authorization.
429The key exceeded its current rate limit.