1. Home
  2. Docs
  3. API Documentation
  4. Users
  5. GetUser

GetUser

This function allow you to fetch information of a certain user on your server.

Request Syntax

{
    "apiKey": "String",
    "email": "String"
}

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 :

email

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",
        "Role": "User"
    }
}

Errors and their Possible Causes

For more information, please refer to the General Errors section.