bidRequirements

Requires permission biddesk:bid:read.

Lists a bid's requirements in matrix order, each with what answers it, optionally in one status, about one thing or owned by one person. 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 BidRequirements($input: BidRequirementsInput!) {
  bidRequirements(input: $input) {
    id
    status
    createdAt
    bidId
    category
    deviationNote
    links {
      id
      createdAt
      requirementId
      targetId
      targetType
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidRequirements($input: BidRequirementsInput!) {\n  bidRequirements(input: $input) {\n    id\n    status\n    createdAt\n    bidId\n    category\n    deviationNote\n    links {\n      id\n      createdAt\n      requirementId\n      targetId\n      targetType\n    }\n  }\n}",
  "variables": {
    "input": {
      "bidId": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "bidId": "id"
  }
}

Response:

{
  "data": {
    "bidRequirements": [
      {
        "id": "id",
        "status": "CLARIFY",
        "createdAt": "2025-01-15T00:00:00Z",
        "bidId": "id",
        "category": "COMMERCIAL",
        "deviationNote": "string",
        "links": [
          {
            "id": "id",
            "createdAt": "2025-01-15T00:00:00Z",
            "requirementId": "id",
            "targetId": "id",
            "targetType": "APPROVAL_STAGE"
          }
        ]
      }
    ]
  }
}

bidRequirements(
  input: BidRequirementsInput!
): [BidRequirement!]!

Arguments

bidRequirements.input ● BidRequirementsInput! non-null input

The bid and the filters.

Type

BidRequirement object

One requirement of a bid, a row of its compliance matrix.