-
Print
-
DarkLight
GET /teams/email-exists
Checks if the given email address exists in the project
Header
Parameter | Type | Description |
---|---|---|
api_token | string | You can get the REST API from Settings > Advanced > API tokens. |
Route Parameters
Parameter | Required | Type | Description |
---|---|---|---|
emailId | Yes | string | The email address that will be checked |
isAnSsoUser | No | boolean | For validating SSO (Single Sign-On) users this flag should be set true |
Sample Response
{ "data": { "exists": true, "user_id": "fe68816b-2222-458b-aasa-fe08461a5ebb" }, "extension_data": null, "context": null, "success": true, "errors": [], "warnings": [], "information": []
}
Response Data
Parameter | Type | Description |
---|---|---|
exists | boolean | A boolean flag indicating if the user exists in the project or not |
user_id | string | The user ID associated with the email. Will be null if the email address does not exist in the project. |
Was this article helpful?