Route: https://api.cytrix.io/GetUser
This function allow you to fetch information of a certain user on your server.
Roles Required: Admin. Users and Private Users can only View themselves.
Request Syntax
{
"apiKey": "String",
"email": "String"
}
Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your CYTRIX given API Key.
How do I get it ? :
Located in the “Profile” section.
Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.
Type :
String
Is it Optional ? :
No.
Parameter Name :
Parameter Usage and Options :
The Email address of the desired user.
Type :
String
Is it Optional ? :
No.
Successful Response
{
"Error": 0,
"Function": "GetUser",
"Data": {
"id": 1234567,
"Email": "[email protected]",
"FirstName": "Name",
"LastName": "Name",
"Phone": "123456789",
"Admin": "False",
"Last_Login": "22-08-2024 | 09:18:40",
"Title": "This title",
"Last_Ip": "192.168.1.1",
"Role": "User"
}
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.