The Admin object
Attribute | Description | Editable? |
id | Vitally's unique ID for the Admin | No |
name | The full name of the Admin. | In-app |
The email of the Admin. | In-app | |
licenseStatus | The current license status of the Admin - 'active', 'deactivated' or 'auto-created' | In-app |
Replace {subdomain} in the endpoints below with your Vitally subdomain.
You can find your subdomain in the URL used to log into Vitally (i.e., https://yoursubdomain.vitally.io
Search Admins GET
Lookup Vitally Admins by email
US Data Center (default):
https://{subdomain}.rest.vitally.io/resources/admins/search
EU Data Center:
https://rest.vitally-eu.io/resources/admins/search
Query Params (exactly one is required)
Param | Type | Description |
| Required The email of the User |
Example Request
GET https://{subdomain}.rest.vitally.io/resources/admins/search?email=user@domain.comExample Response
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Richard Hendricks",
"email": "richard@piedpiper.io",
"licenseStatus": "active"
}