bidTeamCandidates

Requires permission biddesk:bid:update.

Active staff who could work on a bid, each with how many open bids they are on (bids the caller may see) and how many similar bids they worked on and won. The bid's members come first, with their roles. Names only: no email address or phone number. Requires Bid Desk and permission to update 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 BidTeamCandidates($bidId: ID!) {
  bidTeamCandidates(bidId: $bidId) {
    name
    initials
    onThisBid
    openBids
    roles
    similarBids
  }
}

cURL

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

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "bidTeamCandidates": [
      {
        "name": "string",
        "initials": "string",
        "onThisBid": true,
        "openBids": 0,
        "roles": [
          "APPLICATION_ENGINEER"
        ],
        "similarBids": 0
      }
    ]
  }
}

bidTeamCandidates(
  bidId: ID!
  limit: Int
  search: String
): [BidTeamCandidate!]!

Arguments

bidTeamCandidates.bidId ● ID! non-null scalar

The bid being staffed.

bidTeamCandidates.limit ● Int scalar

How many people who are not on the bid to return; 20 by default, at most 50. The bid's current members always come back as well.

bidTeamCandidates.search ● String scalar

Part of a first name, last name or email address; case does not matter. Matches only filter who is listed: an email address is never returned.

Type

BidTeamCandidate object

A staff person who could work on a bid: how many open bids they are on, and how many similar bids they worked on. Carries no contact details.