Skip to main content
POST
/
api
/
run
/
users
/
queries
/
getOnboardingState
getOnboardingState
curl --request POST \
  --url https://connvo-dev.convex.cloud/api/run/users/queries/getOnboardingState \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "args": {}
}'
{
  "errorMessage": "<string>",
  "errorData": {},
  "value": {
    "onboardingComplete": true,
    "profileExists": true,
    "userId": "<string>",
    "completedAt": 123,
    "profileId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Standard user authentication token issued via WorkOS. Provide as Authorization: Bearer <user-token>.

Body

application/json
​
args
object
required

Response

Convex executed your request and returned a result

​
status
enum<string>
required
Available options:
success,
error
​
errorMessage
string
​
errorData
object
​
value
object