bidClauses

Requires permission biddesk:bid:read.

Lists the organization's clause library by key; archived clauses 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 BidClauses {
  bidClauses {
    id
    title
    status
    key
    riskTags
    text
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidClauses {\n  bidClauses {\n    id\n    title\n    status\n    key\n    riskTags\n    text\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bidClauses": [
      {
        "id": "id",
        "title": "string",
        "status": "ACTIVE",
        "key": "string",
        "riskTags": [
          "string"
        ],
        "text": "string"
      }
    ]
  }
}

bidClauses(
  includeArchived: Boolean = false
): [BidClause!]!

Arguments

bidClauses.includeArchived ● Boolean scalar

Also list archived clauses.

Type

BidClause object

One standard contract clause of the organization's library.