Skip to content

Lookup an account

Request

Test the existenc of an account using its username or email address. A user role can optionally be provided to test for the existence of accounts of a certain type.

Security
SessionKey(Required scopes: publiccustomeradministrator)
Bodyapplication/json
identificationstringrequired

The username or email address of the account being looked up

rolestring

The role that an account must be assigned for a successful lookup. If left blank, the lookup will match an account regardles of its role.

curl -i -X POST \
  https://docs.ticketingevents.com/_mock/openapi/lookups \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "identification": "marvin.milk@usmc.gov",
    "role": "host"
  }'

Responses

An account with the specified username or email address was found.

Bodyapplication/json
identificationstring

The username or email address provided for the account lookup

rolestring

The role provided for the account lookup.

namestring

The name linked to the provided identification ,if one was found.

foundboolean

Whether or not an account matching the provided identification and role was found.

Response
{
  "identification": "mothers.milk",
  "role": "host",
  "name": "Marvin Milk",
  "found": false
}