bidDeskSearch

Requires permission biddesk:bid:read.

Searches bids, requirements, cost sheet items, room conversations and published knowledge notes. Returns only what the caller can open: confidential bids they may not see never appear, conversations only from rooms they are a member of, and items only with permission to read cost sheets. Kinds the caller may not read are dropped, not refused. A query shorter than 2 characters returns nothing; one longer than 200 is refused. 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 BidDeskSearch($query: String!) {
  bidDeskSearch(query: $query) {
    total
    bids {
      id
      bidNumber
      title
      bidId
      kind
      path
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidDeskSearch($query: String!) {\n  bidDeskSearch(query: $query) {\n    total\n    bids {\n      id\n      bidNumber\n      title\n      bidId\n      kind\n      path\n    }\n  }\n}",
  "variables": {
    "query": "string"
  }
}
EOF

Variables:

{
  "query": "string"
}

Response:

{
  "data": {
    "bidDeskSearch": {
      "total": 0,
      "bids": [
        {
          "id": "id",
          "bidNumber": "string",
          "title": "string",
          "bidId": "id",
          "kind": "BID",
          "path": "string"
        }
      ]
    }
  }
}

bidDeskSearch(
  kinds: [BidSearchKind!]
  limit: Int = 10
  query: String!
): BidSearchResult!

Arguments

bidDeskSearch.kinds ● [BidSearchKind!] list enum

The kinds to search; omitted or empty searches every kind.

bidDeskSearch.limit ● Int scalar

The most hits per kind, 1 to 50.

bidDeskSearch.query ● String! non-null scalar

The text to look for, 2 to 200 characters.

Type

BidSearchResult object

Bid Desk search hits by kind; a kind the caller may not read, or did not ask for, is empty.