Get An Onboarding Step

This endpoint retrieves a specific onboarding step.

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/{id}/

Parameters

Name	In	Type	Required	Description
id	path	integer	true	A unique integer value identifying this onboarding step

Example Request

JavaScript

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

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

Bash

# You can also use wget
curl -X GET /api/v2/onboarding/{id}/ \
  -H 'Accept: application/json'
  -H 'Authorization: Bearer {access_token}'

Responses

Status	Meaning	Description	Schema
200	OK	Response status code	Onboarding Step