Checks if email already exists in the project

Updated on May 14, 2025

2 minute(s) read

Anand Murali

Prev Next

Get

/v2/Teams/email-exists

Security

API Key

Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Query parameters

emailId

string (email) Required

Provide email address that has to be checked against the current team account list

isAnSsoUser

boolean

Filter SSO team accounts

Defaultfalse

Responses

200

Success

Teams - userId Not Found

This shows the userId is not valid. Kindly reverify your userId and perform the task again.

{
  "data": {
    "exists": true,
    "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8"
  },
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": [],
  "information": []
}

Expand All

object

data

object | null

Response that checks if the given email address exists in the project

exists

boolean

A boolean flag indicating if the user exists in the project or not

user_id

string | null

The user ID associated with the email. Will be null if the email address does not exist in the project.

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

400

Bad Request

Teams - userId Not Found

This shows the userId is not valid. Kindly reverify your userId and perform the task again.

{
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": [],
  "information": []
}

Expand All

object

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

Was this article helpful?