Skip to main content

Get All Onboarding Steps

This endpoint retrieves all onboarding steps.

info

This operation requires authentication. The logged user must be the creator of the community (id=1).

warning

The onboarding APIs are not available for Enterprise plans.

HTTP Request

GET /api/v2/onboarding/

Parameters

NameInTypeRequiredDescription
searchquerystringfalseSearch for a specific step by name starting from a string
limitqueryintegerfalseNumber of results to return per page
offsetqueryintegerfalseThe initial index from which to return the results

Example Request

const headers = {
'Accept':'application/json',
'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/onboarding/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});

Responses

StatusMeaningDescriptionSchema
200OKResponse status codeInline

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
» countintegerfalsenoneTotal results count
» nextstring(uri)¦nullfalsenoneNext page url
» previousstring(uri)¦nullfalsenonePrevious page url
» resultslist(Onboarding Step)falsenoneList of results

Example responses

{
"count": "integer",
"next": "string(uri)",
"previous": "string(uri)",
"results": [{Onboarding Step}]
}