onboarding

Get the Getting started checklist

Get the organization's Getting started checklist: six steps from the first people search to the first launched sequence. Created on first read. Every read while a step is pending checks the workspace for what the pending steps ask for and completes the ones it finds, so progress is right whether the step was done in the dashboard, through the API or from the Chrome extension.

get/onboarding/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/onboarding/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Response

Successful Response

completed_atstring date-time nullable required

When the last step was completed; null while any step is pending.

created_atstring date-time required
dismissed_atstring date-time nullable required

When someone hid the checklist for the workspace; null while it shows.

idstring uuid required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.