bidThreadMessages

Requires permission biddesk:bid:read.

Lists a thread's messages, newest first; the last page ends with the message that started it. Only the bid's members can use its room. Requires Bid Desk and permission to read bids.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query BidThreadMessages($input: BidThreadMessagesInput!) {
  bidThreadMessages(input: $input) {
    nextCursor
    items {
      id
      senderName
      createdAt
      content
      deleted
      parentId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidThreadMessages($input: BidThreadMessagesInput!) {\n  bidThreadMessages(input: $input) {\n    nextCursor\n    items {\n      id\n      senderName\n      createdAt\n      content\n      deleted\n      parentId\n    }\n  }\n}",
  "variables": {
    "input": {
      "threadId": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "threadId": "id"
  }
}

Response:

{
  "data": {
    "bidThreadMessages": {
      "nextCursor": "string",
      "items": [
        {
          "id": "id",
          "senderName": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "content": "string",
          "deleted": true,
          "parentId": "id"
        }
      ]
    }
  }
}

bidThreadMessages(
  input: BidThreadMessagesInput!
): BidMessagePage!

Arguments

bidThreadMessages.input ● BidThreadMessagesInput! non-null input

The thread and the page.

Type

BidMessagePage object

A page of a thread's messages, newest first; the last page ends with the thread's first message.