Onboarding

Onboarding state

Where onboarding stands: confirmed steps and their confirmation times. The profile can poll this while onboarding is open. Public, uncached, and limited to step names and timestamps; it does not expose pending sources or private prepared text.

Adding an artist discovers public links and Latest material while About and Lore remain private. Approving the claim does not confirm review or publication. A fresh open discovers or reuses saved profiles, then stops for explicit source review. Interview answers are optional and individually answered or skipped. About is public only after an explicit publish turn. There is no fixed completion time. An artist with no onboarding, or an unknown ID, 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, confirmed after the optional questions are answered or skipped.

format: date-time

publishstring | nullrequired

The Lore and About written. The About can show.

format: date-time