Users Lists

Introduction

Using this API object you can work with user lists of your application. The list of users will only display those users who have given access to their profile and installed your application.

Invoke Methods

To invoke methods, use the Users object. All methods are located within this URL:

https://cp.ocugine.pro/api/users/

Available Methods

Method Usage For
Users.get_users_list Get Users List API/SDK

Users.get_users_list

This method is used to display a list of all users of your application, starting with the recently registered. The server will issue a list of users only taking into account that the user has installed the application and has given him access to his profile.

Method URL

https://cp.ocugine.pro/api/users/get_users_list/

Request Data

Name Type Usage
app_id double Application ID
app_key string Application Client Key
page (not required) int Page number (up to 20 users per page)
lang (not required) string Language

Response Data

Name Type Usage
complete bool Operation Status
message string Error Message
data array/object Data object

Data Object

Name Type Usage
list array Users list based on Base Data model

Base Data

Name Type Usage
uid double Profile UID
first_name string First Name
last_name string Last Name
avatar string User Avatar URL
email string User Email
profile_data object Profile Data
profile_type int Profile Type
group_id double User Group ID
ban_state object User Ban State inside Application

Ban State Object

Name Type Usage
uid double Application Ban UID
profile_uid double Banned Profile UID
project_id double Banned User Application ID
ban_state bool Ban State (true - banned, false - not banned)
ban_escape double Ban Escape Time (Unix Time or 0 - forever)
ban_reason string Ban Reason

Response Example

{
  "complete": true,
  "message": null,
  "data": {
    "list": [
      {
        "uid": "17",
        "first_name": "Ocugine",
        "last_name": "Services",
        "avatar": "",
        "email": "[email protected]",
        "profile_data": [],
        "profile_type": "1",
        "group_id": "30",
        "ban_state": {
          "uid": -1,
          "profile_uid": "17",
          "project_id": "59",
          "ban_state": false,
          "ban_escape": 0,
          "ban_reason": ""
        }
      },
      {
        "uid": "18",
        "first_name": "John",
        "last_name": "Doe",
        "avatar": "",
        "email": "[email protected]",
        "profile_data": [],
        "profile_type": "1",
        "group_id": "-1",
        "ban_state": {
          "uid": -1,
          "profile_uid": "17",
          "project_id": "59",
          "ban_state": false,
          "ban_escape": 0,
          "ban_reason": ""
        }
      }
    ]
  }
}