bidTemplates

Requires permission biddesk:bid:read.

Lists the organization's bid templates by name; archived ones only when asked. 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 BidTemplates {
  bidTemplates {
    id
    name
    createdAt
    deletedAt
    isDefault
    updatedAt
    stages {
      daysBeforeDue
      stageKey
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidTemplates {\n  bidTemplates {\n    id\n    name\n    createdAt\n    deletedAt\n    isDefault\n    updatedAt\n    stages {\n      daysBeforeDue\n      stageKey\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bidTemplates": [
      {
        "id": "id",
        "name": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "deletedAt": "2025-01-15T00:00:00Z",
        "isDefault": true,
        "updatedAt": "2025-01-15T00:00:00Z",
        "stages": [
          {
            "daysBeforeDue": 0,
            "stageKey": "APPROVAL"
          }
        ]
      }
    ]
  }
}

bidTemplates(
  includeArchived: Boolean
): [BidTemplate!]!

Arguments

bidTemplates.includeArchived ● Boolean scalar

Also list archived templates.

Type

BidTemplate object

A bid template: ordered stages, each due a number of working days before a bid's due date, and the working week it counts in.