SnozeDevelopers
API referenceSurfaces

List the comments on a surface

Returns every block comment on the surface in creation order, each with its author's display name and avatar. Requires `blocks:read` on the surface, which is resolved per item exactly like reading the surface itself, so comments are never visible more widely than the page.

GET
/v1/workspaces/{workspaceId}/surfaces/{surfaceId}/comments
AuthorizationBearer <token>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

In: header

Path Parameters

workspaceId*string
surfaceId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/workspaces/string/surfaces/string/comments"
{  "data": [    {      "id": "string",      "workspaceId": "string",      "surfaceId": "string",      "blockId": "string",      "authorUserId": "string",      "authorDisplayName": "string",      "authorAvatarUrl": "string",      "body": "string",      "resolvedAt": "string",      "createdAt": "string"    }  ]}