Setup checklist status

GET

/v1/home/onboarding

const url = 'https://shareout.site/v1/home/onboarding';
const options = {method: 'GET', headers: {Authorization: 'Bearer <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://shareout.site/v1/home/onboarding \
  --header 'Authorization: Bearer <token>'

Returns the signed-in user’s onboarding checklist for a workspace, or { "track": null } when no checklist applies (external sharees, established workspaces, or members who joined more than 14 days ago). Task labels are client-side; the server returns keys, done flags, and action hints.

Authorizations

bearerAuth

Parameters

Query Parameters

workspace

string

Workspace id or slug.

Responses

200

Checklist status

application/json

object

track

string

nullable

Allowed values: admin member

tasks

Array<object>

object

key

string

done

boolean

skippable

boolean

pct

integer

<= 100

eligible

boolean

dismissed

boolean

celebrated

boolean

Example

{
  "track": "admin"
}