bidStagePlan

Requires permission biddesk:bid:read.

A live bid's stage plan: its stages in order with their deadlines, in the organization's time zone. 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 BidStagePlan($bidId: ID!) {
  bidStagePlan(bidId: $bidId) {
    bidDueOn
    bidId
    bidVersion
    stages {
      id
      bidId
      completedAt
      dueOn
      position
      stageKey
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidStagePlan($bidId: ID!) {\n  bidStagePlan(bidId: $bidId) {\n    bidDueOn\n    bidId\n    bidVersion\n    stages {\n      id\n      bidId\n      completedAt\n      dueOn\n      position\n      stageKey\n    }\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "bidStagePlan": {
      "bidDueOn": "string",
      "bidId": "id",
      "bidVersion": 0,
      "stages": [
        {
          "id": "id",
          "bidId": "id",
          "completedAt": "2025-01-15T00:00:00Z",
          "dueOn": "string",
          "position": 0,
          "stageKey": "APPROVAL"
        }
      ]
    }
  }
}

bidStagePlan(
  bidId: ID!
): BidStagePlan!

Arguments

bidStagePlan.bidId ● ID! non-null scalar

The bid.

Type

BidStagePlan object

A bid's stage plan: its stages in order with their deadlines.