Administration

List all Administrators

Returns a list of your Administrators.

get/admin/administration/administrators

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/administration/administrators
  • Auth: HTTP basic

Response

partner_idnumber

Partners ID

role_namestring

Administrator`s role name 'administrator', 'super-administrator', 'customer-creator', etc. You can get it at page "Administration / Roles".

loginstring required

Administrator's login

namestring required

Administrator's name

emailstring required

Administrator's email

timeoutnumber

Timeout

router_accessstring

Router access

phonestring

Phone

avatar_api_urlstring

If administrator has avatar here will be url for downloading it via api

download_avatar_linkstring

If administrator has avatar here will be link for downloading

send_from_my_namestring
calendar_colorstring

Color of calendar

idnumber

Administrator ID

Example response

[
  {
    "partner_id": 1,
    "role_name": "administrator",
    "login": "main",
    "name": "Main",
    "email": "main@email.com",
    "timeout": 1200,
    "router_access": "none",
    "phone": "+420123456879",
    "avatar_api_url": "admin/config/download/admins_avatar--1",
    "download_avatar_link": "https://yourdomain/files?id=1&type=admins_avatar",
    "send_from_my_name": "0",
    "calendar_color": "#FF0000",
    "id": 1
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.