A valid request URL is required to generate request examples{
"checklists": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"active": true,
"dismissals": 123,
"hidden": 123,
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"unlocks_after": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"selectable": true,
"snooze_days": 7,
"hint_pending": "<string>",
"hint_done": "<string>",
"hint_locked": "<string>",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"steps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"title": "<string>",
"kind": "event",
"event_type": "<string>",
"feature_key": "<string>",
"action_url": "<string>",
"action_label": "<string>",
"hint_pending": "<string>",
"hint_done": "<string>",
"position": 123,
"sightings": 123,
"last_seen": "2023-11-07T05:31:56Z"
}
]
}
],
"event_types": [
"<string>"
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}List onboarding checklists
Requires engagement:manage — reads included, like feature flags. A checklist is your own copy and your own completion numbers, and no wider permission shows any of it.
Inactive checklists are listed and marked: one still being written is exactly what this screen is opened to finish. Every checklist comes back with its steps in display order.
event_types is the vocabulary an event step may wait on, derived from the facts this system actually publishes. It travels on the read rather than being hard-coded in a screen, so a screen cannot go on offering a type the API stopped accepting.
A valid request URL is required to generate request examples{
"checklists": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"active": true,
"dismissals": 123,
"hidden": 123,
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"unlocks_after": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"selectable": true,
"snooze_days": 7,
"hint_pending": "<string>",
"hint_done": "<string>",
"hint_locked": "<string>",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"steps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"title": "<string>",
"kind": "event",
"event_type": "<string>",
"feature_key": "<string>",
"action_url": "<string>",
"action_label": "<string>",
"hint_pending": "<string>",
"hint_done": "<string>",
"position": 123,
"sightings": 123,
"last_seen": "2023-11-07T05:31:56Z"
}
]
}
],
"event_types": [
"<string>"
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Query Parameters
Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.
live, test