bidDeskPilotCandidates

Requires permission biddesk:settings:manage.

Recent past bids from the imported history that can be replayed as the pilot bid, newest decision first, at most 20. No amounts. Requires Bid Desk and permission to manage its settings.

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 BidDeskPilotCandidates {
  bidDeskPilotCandidates {
    id
    title
    customerName
    decidedAt
    externalRef
    outcome
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidDeskPilotCandidates {\n  bidDeskPilotCandidates {\n    id\n    title\n    customerName\n    decidedAt\n    externalRef\n    outcome\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bidDeskPilotCandidates": [
      {
        "id": "id",
        "title": "string",
        "customerName": "string",
        "decidedAt": "2025-01-15T00:00:00Z",
        "externalRef": "string",
        "outcome": "LOST"
      }
    ]
  }
}

bidDeskPilotCandidates(
  take: Int
): [BidDeskPilotCandidate!]!

Arguments

bidDeskPilotCandidates.take ● Int scalar

How many to return, 1 to 20; defaults to 20.

Type

BidDeskPilotCandidate object

A past bid from the imported history that can be replayed as the pilot bid. Carries no amounts.