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
    archived
    isSystem
    content
    attachments {
      _id
      uri
      title
    }
    read
    orderId
    orderIncId
    uri
    via
  }
}

Variables

{
    "messageRef": "5546c7198ea27676a32cb462"
}

Response

{
    "message": {
        "_id": "d6ee680634bc5863744529af",
        "created": 1741587523561,
        "sender": {
            "name": "example",
            "alias": "example",
            "email": "email@example.com",
            "ref": "f5cc1a7a17e0d900557760bf"
        },
        "subject": "example",
        "message": "example",
        "fromBuyer": true,
        "flagged": true,
        "archived": true,
        "isSystem": true,
        "content": "example",
        "attachments": [
            {
                "_id": "e57489024e5c2744a2ad5a69",
                "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

Name	Type	Description
messageRef	ID!	Reference ID of the message to retrieve.

Returns

Message