onboarding

Get active onboarding questions for the specified scope

get/v1/onboarding/questions

Request

  • Base URL
    https://api.b3os.org (the document declares no server; this is the origin it was published from)
  • URL
    https://api.b3os.org/v1/onboarding/questions
  • Auth
    none declared

Query parameters

scopestring required

Scope: 'user' or 'org'

limitinteger

Number of items (default 20, max 100)

offsetinteger

Offset for pagination (default 0)

Response

OK

codeinteger
messagestring
requestIdstring

Example response

{
  "code": 200,
  "data": {
    "items": [
      {
        "id": "onboarding_q1",
        "isRequired": true,
        "questionOrder": 1,
        "questionText": "What brings you to B3OS?",
        "questionType": "text"
      }
    ]
  },
  "message": "success",
  "requestId": "req_abc123"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.