Get onboarding checklist REST API

GET

/api/user/onboarding

const url = 'https://app.hitkeep.com/api/user/onboarding';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.hitkeep.com/api/user/onboarding \
  --cookie hk_token=<hk_token>

Returns an onboarding checklist computed from sites, tracking status, team membership, and report subscription state.

Authorizations

cookieAuth

Responses

200

Onboarding state

application/json

object

complete

boolean

dismissed

boolean

steps

Array<object>

object

complete

boolean

current

integer

key

string

Allowed values: create_site verify_tracking automatic_events invite_teammate schedule_report

site_domain

string

site_id

string format: uuid

target

integer

Example

{
  "steps": [
    {
      "key": "create_site"
    }
  ]
}