Skip to main content

message Query

Description

Retrieves a single message by its reference ID.

query message($messageRef: ID!) {
message(messageRef: $messageRef) {
_id
created
sender {
name
alias
email
ref
}
subject
message
fromBuyer
flagged
content
attachments {
_id
uri
title
}
read
orderId
orderIncId
uri
via
}
}

Variables

{
"messageRef": "cac12c1e4d4e6b0ef1ddae3d"
}

Response

{
"message": {
"_id": "1bd8b9c3672e078235e50c6e",
"created": 1758707697213,
"sender": {
"name": "example",
"alias": "example",
"email": "email@example.com",
"ref": "da0ede79da0c7ef6fc8c59d2"
},
"subject": "example",
"message": "example",
"fromBuyer": true,
"flagged": true,
"content": "example",
"attachments": [
{
"_id": "1d457104a62048b04c67ed10",
"uri": "https://www.my-common-ground-store.com/release/1763553751/release-artist-release-name",
"title": "example"
}
],
"read": true,
"orderId": "example",
"orderIncId": 42,
"uri": "https://www.my-common-ground-store.com/release/1763553751/release-artist-release-name",
"via": "example"
}
}

Arguments

NameTypeDescription
messageRefID!Reference ID of the message to retrieve.

Returns

Message