GET v1/User/Exists?email={email}

Used to see if a user exists in the system for a given Email. Returns any known information about the user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
email

Email of the User to check for

string

Required

Body Parameters

None.

Response Information

Resource Description

UserExistsResponse
NameDescriptionTypeAdditional information
userExists

Whether or not the user exists

boolean

None.

fieldValue

Any information gathered about the user if they exist in the system

Collection of FieldValue

None.

Response Formats

application/json, text/json

Sample:
{
  "userExists": true,
  "fieldValue": [
    {
      "field": "sample string 1",
      "value": "sample string 2"
    },
    {
      "field": "sample string 1",
      "value": "sample string 2"
    }
  ]
}

text/xml

Sample:
<UserExistsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CitySpark.API.Models">
  <fieldValue>
    <FieldValue>
      <field>sample string 1</field>
      <value>sample string 2</value>
    </FieldValue>
    <FieldValue>
      <field>sample string 1</field>
      <value>sample string 2</value>
    </FieldValue>
  </fieldValue>
  <userExists>true</userExists>
</UserExistsResponse>