bidRoomPresence

Requires permission biddesk:bid:read.

Lists the bid's members who have its room open right now. Requires Bid Desk, permission to read bids and membership of the bid.

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 BidRoomPresence($bidId: ID!) {
  bidRoomPresence(bidId: $bidId) {
    name
    initials
    since
    userId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidRoomPresence($bidId: ID!) {\n  bidRoomPresence(bidId: $bidId) {\n    name\n    initials\n    since\n    userId\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "bidRoomPresence": [
      {
        "name": "string",
        "initials": "string",
        "since": "2025-01-15T00:00:00Z",
        "userId": "id"
      }
    ]
  }
}

bidRoomPresence(
  bidId: ID!
): [BidRoomPresence!]!

Arguments

bidRoomPresence.bidId ● ID! non-null scalar

The bid.

Type

BidRoomPresence object

A member of the bid who has its room open right now.