/
User (/user/)

User (/user/)

Owned by esnata (Unlicensed)
Last updated: Jul 05, 2021
2 min read

You can test API methods on the interactive API browser page and without writing code
Some of the resources described on the page may not be available by default due to the type of application (see Creating and authorizing applications).

The resource is intended for obtaining information about a logged-in user. Can be used to get the user ID.

Description of data structures

Name

Type

Description

Name

Type

Description

access

string

User access level. It can take the values full (full access) and read_only (read-only access, only GET requests are allowed)

admin

boolean

It is set to true if the user type is "administrator", in other cases it is set to false ("administrator" level user is outside the scope of this documentation)

client_id

long

The user's client ID. Specified if the user type is "client"

dealer_id

long

ID of the user's dealer. Specified if the user type is "dealer" ("dealer" level user is outside the scope of this documentation)

extension_group_id

long

ID of the user's internal numbers group. Specified if the user type is "internal numbers group"

extension_id

long

ID of the user's internal number. Specified if the user type is "internal number"

extra_params

string

Additional parameters

id

long

Unique user ID

login

string

Unique user login

timezone

string

User's time zone

Example

After the application is authorized and the token is received, the following request is executed:

System response:

{   "dealer_id": null,   "admin": false,   "extra_params": null,   "access": "full",   "extension_id": null,   "client_id": 100,   "extension_group_id": null,   "timezone": "Europe/Moscow",   "login": "client_login",   "id": 123 }

From the response, it can be seen that the work is done on behalf of a user of the "client" level with the login "client_login" and the ID 100.

Resources

GET /user/

Get information about the current authorized user

Response fields

Name

Type

Name

Type

dealer_id

long

admin

boolean

extra_params

string

access

string

extension_id

long

client_id

long

extension_group_id

long

timezone

string

login

string

id 

long

Related content