Skip to content

GET /message

Get Messages

GET
/message

Retrieve messages for a given recipient, sorted by creation time.

Queries the message edge collection filtering by _to == recipient_id.
The recipient is typically an Issue or User document ID
(e.g. Issue/abc123). Results are sorted ascending by created timestamp.

Emits: (direct transaction — no event class)

Required scope: collaboration:message:read

Authorizations

OAuth2PasswordBearer
password Flow
Token URL"/api/auth"
Scopes:
  • "admin"User can access and edit users and system settings
  • "library"User can access and edit products
  • "production"User can access and edit production plans
  • "operator"User can access the operator panel and make production declarations

Parameters

Query Parameters

recipient_id*
Type
string
Required

Responses

Successful Response

application/json
JSON
[
  
{
  
  
"_id": "string",
  
  
"_key": "string",
  
  
"_rev": "string",
  
  
"_from": "User/user42",
  
  
"_to": "Issue/issue_001",
  
  
"content": "Inspection failed at step 3 — dimensional check out of tolerance.",
  
  
"created": "2026-05-04T10:00:00Z",
  
  
"updated": "2026-05-04T10:05:00Z",
  
  
"deleted": "string"
  
}
]

Samples

Powered by VitePress OpenAPI

Released under the Apache 2.0 License.