Onboarding

Onboarding state

Where an artist's onboarding build is: which steps are confirmed and when. The artist's profile page polls this while the build runs, about every 2 seconds, and repaints each section as its step confirms: Links on profiles, Lore on vault, About on publish. It stops once complete is true.

Public: no credentials. It returns only step names and confirmation times. Responses aren't cached.

On a fresh claim the auto-build (open on the onboarding chat) confirms profiles, then vault, then interview and publish together when the About is saved: about 5, 9 and 22 seconds in on staging. An artist with no onboarding, or an ID that isn't an artist, returns every step null and currentStep profiles.

GET/api/onboarding/{artistId}/state

GET

GET/api/onboarding/aab92f80-f9e1-4299-aa33-7dd85c8de5d3/state

Path

artistIdstringrequired

The artist's ID (a UUID). Staging and production IDs differ.

cURL

curl --request GET \
  --url 'https://musicnerd-api.vercel.app/api/onboarding/aab92f80-f9e1-4299-aa33-7dd85c8de5d3/state'

Send the request to see the live response here.

cURL

curl --request GET \
  --url 'https://musicnerd-api.vercel.app/api/onboarding/YOUR_ARTIST_ID/state'

{
  "status": "ok",
  "complete": true,
  "currentStep": null,
  "steps": {
    "profiles": "2026-10-02T23:33:42.122Z",
    "vault": "2026-10-02T23:33:46.437Z",
    "interview": "2026-10-02T23:33:58.667Z",
    "publish": "2026-10-02T23:33:58.667Z"
  }
}

Authorizations

None. This endpoint is public.

Path Parameters

artistIdstringrequired

The artist's ID (a UUID). Staging and production IDs differ.

Response

application/json

The artist's onboarding state.

statusstring · enumrequired

Values: "ok"

completebooleanrequired

True once publish is confirmed: the profile is built. The page stops polling here.

currentStepstring | nullrequired

The first step, in order, without a confirmation. null once all four are confirmed. profiles for an artist that hasn't started.

Values: "profiles", "vault", "interview", "publish", null

stepsobjectrequired

When each step was confirmed (ISO 8601, UTC), or null if it hasn't been.

Properties

profilesstring | nullrequired

Profiles found and linked. The Links section can show them.

format: date-time

vaultstring | nullrequired

Sources saved. The Lore section can show them.

format: date-time

interviewstring | nullrequired

The interview step. The auto-build confirms it together with publish.

format: date-time

publishstring | nullrequired

The Lore and About written. The About can show.

format: date-time