Skip to main content
PATCH
Hide the Getting started checklist

Authorizations

X-API-Key
string
header
required

Body

application/json

The change a person makes to the checklist: hiding it for the workspace.

dismissed
boolean
required

Send true to hide the checklist for the whole workspace. Hiding is one way: nothing shows the sidebar widget again.

Response

Successful Response

completed_at
string<date-time> | null
required

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

created_at
string<date-time>
required
dismissed_at
string<date-time> | null
required

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

id
string<uuid>
required
items
OnboardingItemReadSchema · object[]
required

The steps, in checklist order.

targets
OnboardingTargetsReadSchema · object
required

Where the pending steps deep-link; every field is null once the checklist is done.

updated_at
string<date-time>
required