Contents x
Checks if email already exists in the project
  • 16 Mar 2023
  • 2 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Checks if email already exists in the project

  • Updated on 16 Mar 2023
  • 2 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
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 Required

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

isAnSsoUser
boolean

Filter SSO team accounts

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
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.

extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

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.

{
  "data": {
    "exists": false,
    "user_id": null
  },
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": [],
  "information": []
}
Expand All
object
data
object
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.

extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

Was this article helpful?
What's Next