Get user registration state

Get user registration state

get

Tells whether a user is registered and whether it needs to set its password.

Path parameters
usernameOrEmailstringRequired

Username or email

Responses
200
OK
application/json
Responseall of
get
GET /v1/api-user-need-to-set-password/{usernameOrEmail} HTTP/1.1
Host: studio.edgeimpulse.com
Accept: */*
200

OK

{
  "success": true,
  "error": "text",
  "email": "text",
  "needPassword": true,
  "whitelabels": [
    "text"
  ],
  "trials": [
    {
      "id": 1,
      "userId": 1,
      "organizationId": 1,
      "created": "2025-07-01T15:57:27.922Z",
      "expirationDate": "2020-01-01T00:00:00Z",
      "notes": "This is a trial for the company's new project.",
      "expiredDate": "2025-07-01T15:57:27.922Z",
      "deletedDate": "2025-07-01T15:57:27.922Z",
      "upgradedDate": "2025-07-01T15:57:27.922Z"
    }
  ],
  "emailVerified": true,
  "idps": [
    "okta",
    "google"
  ]
}

Last updated

Was this helpful?