GET /v1/onboarding/questions

Get active onboarding questions for the specified scope

GET /v1/onboarding/questions
Get active onboarding questions for the specified scope

Query Parameters

scope string required query
Scope: 'user' or 'org'
limit integer optional query
Number of items (default 20, max 100)
offset integer optional query
Offset for pagination (default 0)

Responses

200 OK
application/json
code integer
data object
hasMore boolean
items object[]
Array of:
id string
isRequired boolean
metadata object
questionOrder integer
questionText string
questionType string
limit integer
offset integer
message string
requestId string
400 Bad Request
500 Internal Server Error 
curl -X GET 'https://api.example.com/v1/onboarding/questions?scope=string' \  -H 'Authorization: Bearer YOUR_API_TOKEN'
const response = await fetch('https://api.example.com/v1/onboarding/questions?scope=string', {  method: 'GET',  headers: {      "Authorization": "Bearer YOUR_API_TOKEN"  }});const data = await response.json();console.log(data);
import requestsheaders = {    'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.get('https://api.example.com/v1/onboarding/questions?scope=string', headers=headers)print(response.json())
package mainimport (	"fmt"	"io"	"net/http")func main() {	req, _ := http.NewRequest("GET", "https://api.example.com/v1/onboarding/questions?scope=string", nil)	req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")	resp, _ := http.DefaultClient.Do(req)	defer resp.Body.Close()	result, _ := io.ReadAll(resp.Body)	fmt.Println(string(result))}
200 Response 
{  "code": 200,  "data": {    "hasMore": true,    "items": [      {        "id": "onboarding_q1",        "isRequired": true,        "metadata": "<object>",        "questionOrder": 1,        "questionText": "What brings you to B3OS?",        "questionType": "text"      }    ],    "limit": 123,    "offset": 123  },  "message": "success",  "requestId": "req_abc123"}
Previous Get Slack OAuth URL
Next POST /v1/onboarding/responses