v1
Onboarding
Onboarding

Get Onboarding State

What should this authenticated person be shown?

Three answers, because "/onboarding/create-shop" is really "you have no shop yet — here is what to do about it":

  • join — someone already invited them. Offer this, never a create form, or a person told "go to gnosis.com" instead of opening their invitation email quietly creates a duplicate shop.
  • create — nobody is expecting them
  • already_in_shop — a live users row names a shop; the frontend should send them there. A WorkOS organization on the token is not enough: an account can be signed in and still have no shop to enter.
get/api/v1/onboarding/state

Request

  • Base URL: https://api.jeevyfabrication.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.jeevyfabrication.com/api/v1/onboarding/state
  • Auth: none declared

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.