bidDeskOnboardingSteps

Requires permission biddesk:bid:read.

The onboarding steps with their status and usual owners; no counts. 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 BidDeskOnboardingSteps {
  bidDeskOnboardingSteps {
    status
    key
    ownerPresetKeys
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidDeskOnboardingSteps {\n  bidDeskOnboardingSteps {\n    status\n    key\n    ownerPresetKeys\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bidDeskOnboardingSteps": [
      {
        "status": "DONE",
        "key": "DATA",
        "ownerPresetKeys": [
          "string"
        ]
      }
    ]
  }
}

bidDeskOnboardingSteps: [BidDeskOnboardingStep!]!

Type

BidDeskOnboardingStep object

One onboarding step with its status and who usually owns it.