bidDeskOnboardingSources

Requires permission biddesk:settings:manage.

Lists the organisation's Bid Desk set-up files, newest first, at most 200; optionally only those in one state. Requires Bid Desk and permission to manage Bid Desk settings.

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 BidDeskOnboardingSources {
  bidDeskOnboardingSources {
    id
    failureCode
    fileName
    status
    createdAt
    contentType
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidDeskOnboardingSources {\n  bidDeskOnboardingSources {\n    id\n    failureCode\n    fileName\n    status\n    createdAt\n    contentType\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bidDeskOnboardingSources": [
      {
        "id": "id",
        "failureCode": "string",
        "fileName": "string",
        "status": "FAILED",
        "createdAt": "2025-01-15T00:00:00Z",
        "contentType": "string"
      }
    ]
  }
}

bidDeskOnboardingSources(
  status: BidDeskOnboardingSourceStatus
): [BidDeskOnboardingSource!]!

Arguments

bidDeskOnboardingSources.status ● BidDeskOnboardingSourceStatus enum

Only files in this state.

Type

BidDeskOnboardingSource object

One of the organisation's own set-up files (a BOM, a price list, past quotes, terms), stored privately for Bid Desk onboarding. The file itself is never exposed here.