bids

Requires permission biddesk:bid:list.

Lists the organization's live bids, soonest due first, filtered by status, stage, customer, owner, due date or text in the number or title. Requires Bid Desk and permission to list 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 Bids {
  bids {
    hasMore
    totalCount
    bids {
      id
      bidNumber
      title
      status
      createdAt
      closedAt
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Bids {\n  bids {\n    hasMore\n    totalCount\n    bids {\n      id\n      bidNumber\n      title\n      status\n      createdAt\n      closedAt\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bids": {
      "hasMore": true,
      "totalCount": 0,
      "bids": [
        {
          "id": "id",
          "bidNumber": "string",
          "title": "string",
          "status": "CANCELLED",
          "createdAt": "2025-01-15T00:00:00Z",
          "closedAt": "2025-01-15T00:00:00Z"
        }
      ]
    }
  }
}

bids(
  filter: BidFilterInput
): BidPage!

Arguments

bids.filter ● BidFilterInput input

Which bids to list, and which page. Default: all, first 50.

Type

BidPage object

A page of bids.