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


Route: https://kayran.live/api/GetUserProfile

This function allows you to fetch a quick display of your Profile.

Roles Required: Admin, User and Private User.

Request Syntax

    "apiKey": "String"

Request Parameters

Parameters being used in the Request

Parameter Name :


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 :


Is it Optional ? :


Successful Response

    "Error": 0,
    "Function": "GetUserProfile",
    "Data": {
        "email": "user@*****",
        "firstName": "Fname",
        "lastName": "Lname",
        "phone": "123465789",
        "emailNotifications": {
            "onDelete": "False",
            "onStop": "False",
            "onChangeStatus": "False",
            "onQueueStart": "False",
            "onScheduleStart": "True",
            "onAborted": "False"

Errors and their Possible Causes

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