Route: https://api.kayran.live/GetUsers
Using this function, you can fetch all the details about all the existing users on your server.
Roles Required: Admin.
Request Syntax
{
"apiKey": "String",
"sort": "String",
"desc": True/False
}
Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your Kayran 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 :
sort
Parameter Usage and Options :
In case you want to fetch the Users in a specific order.
Value :
id|name|email|admin|phone|role|login|ip|firstname|lastname
Type :
String
Is it Optional ? :
Yes.
Parameter Name :
desc
Parameter Usage and Options :
In case you want to fetch the Users in a descending order.
Value :
True/False
Type :
Boolean
Is it Optional ? :
No – if you enable sort.
Successful Response
{"Error": 0, "Function": "GetUsers", "Data": "[{\"Id\": 123456, \"Email\": \"[email protected]\", \"FirstName\": \"Name\",
\"LastName\": \"Name\", \"Phone\": \"123456789\", \"Admin\": \"False\", \"Last_Login\": \"30/05/2022 | 06:31:22 AM\",
\"Last_Ip\": \"1.1.11.11\", \"Role\": \"User\"}
Errors and their Possible Causes
For more information, please refer to the General Errors section.