WORKSECTION

Участник

Получение списка пользователей через API: get_users

Пример get_users запроса

https://your-domain.com/api/admin/v2/?action=get_users&hash=HASH
В этом запросе параметр page не требуется

Возвращает данные пользователей аккаунта
Пример JSON ответа

{
    "status": "ok",
    "data": [
        {
            "id": "USER_ID",
            "first_name": "USER_FIRST_NAME",
            "last_name": "USER_LAST_NAME",
            "name": "USER_NAME",
            "title": "USER_POSITION",
            "avatar": "URL",
            "group": "USER_GROUP",
            "department": "USER_DEPARTMENT",
            "role": "USER_ROLE",
            "email": "USER_EMAIL",
            "phone": "USER_PHONE",
            "address": "USER_ADDRESS"
        }
    ]
}

Приглашение пользователя в аккаунт через API: add_user

Пример add_user запроса

https://your-domain.com/api/admin/v2/?action=add_user&
email=USER_EMAIL&first_name=USER_FIRST_NAME&last_name=USER_LAST_NAME&
hash=HASH
Пользователь будет приглашен в аккаунт в основную команду
В этом запросе параметр page не требуется

Обязательные параметры:
  • email – email пользователя
  • first_name – имя пользователя
  • last_name – фамилия пользователя

Необязательные параметры:
  • title – должность пользователя
  • department – отдел пользователя
  • group – название команды

При успешном выполнении запроса, ответ будет содержать статус ok и следующие данные

{
    "status": "ok",
    "data": {
        "id": "USER_ID",
        "first_name": "USER_FIRST_NAME",
        "last_name": "USER_LAST_NAME",
        "name": "USER_NAME",
        "title": "USER_POSITION",
        "avatar": "URL",
        "group": "GROUP_NAME",
        "department": "USER_DEPARTMENT",
        "role": "User",
        "email": "USER_EMAIL"
    }
}

Подписать пользователя на задачу через API: subscribe

Пример subscribe запроса

https://your-domain.com/api/admin/v2/?action=subscribe&
page=/project/PROJECT_ID/TASK_ID/&email_user=USER_EMAIL&hash=HASH 
Параметр email_user должен содержать email подписываемого пользователя

При успешном выполнении запроса, ответ будет содержать статус Ок
{
"status": "ok"
}

Отписать пользователя от задачи через API: unsubscribe

Пример unsubscribe запроса

https://your-domain.com/api/admin/v2/?action=unsubscribe&
page=/project/PROJECT_ID/TASK_ID/&email_user=USER_EMAIL&hash=HASH 
Параметр email_user должен содержать email отписываемого от задания пользователя

При успешном выполнении запроса, ответ будет содержать статус Ок
{
"status": "ok"
}

Создание контакта через API: add_contact

Пример add_contact запроса

https://your-domain.com/api/admin/v2/?action=add_contact&
name=CONTACT_NAME&email=CONTACT_EMAIL&hash=HASH 
Контакт не получает приглашение в аккаунт!
В этом запросе параметр page не требуется

Обязательные параметры:
  • email – email контакта
  • name – имя и фамилия контакта

Необязательные параметры:
  • title – должность контакта
  • group – название папки контактов
  • phone – номер телефона контакта
  • phone2 – второй номер телефона контакта
  • address – адрес контакта

При успешном выполнении запроса, ответ будет содержать статус ok и следующие данные

{
    "status": "ok",
    "data": {
        "id": "CONTACT_ID",
        "first_name": "CONTACT_FIRST_NAME",
        "last_name": "CONTACT_LAST_NAME",
        "name": "CONTACT_NAME",
        "title": "CONTACT_POSITION",
        "group": "GROUP_NAME",
        "email": "CONTACT_EMAIL",
        "phone": "CONTACT_PHONE",
        "address": "CONTACT_ADDRESS"
    }
}

Создание команды для участников в аккаунте через API: add_user_group

Пример add_user_group запроса 

https://your-domain.com/api/admin/v2/?action=add_user_group&
title=USER_GROUP&client=1&hash=HASH
Проверяет на возможное существование такой команды, и создает новую, если необходимо
В этом запросе параметр page не требуется

Обязательные параметры:
  • title – название команды

Необязательные параметры:
  • client=1 – команда "Клиент"
  • client=0 – команда "Моя"

При успешном выполнении, ответ будет содержать статус ok и данные

{
    "status": "ok",
    "data": {
        "id": "GROUP_ID",
        "title": "USER_GROUP",
        "type": "company",
        "client": 1
    }
}

Получение списка контактов через API: get_contacts

Пример get_contacts запроса

https://your-domain.com/api/admin/v2/?action=get_contacts&hash=HASH 
Возвращает данные контактов аккаунта
В этом запросе параметр page не требуется

Пример JSON ответа

{
    "status": "ok",
    "data": [
        {
            "id": "CONTACT_ID",
            "first_name": "CONTACT_FIRST_NAME",
            "last_name": "CONTACT_LAST_NAME",
            "name": "CONTACT_NAME",
            "title": "CONTACT_POSITION",
            "group": "CONTACT_GROUP",
            "email": "CONTACT_EMAIL",
            "phone": "CONTACT_PHONE",
            "address": "CONTACT_ADDRESS"
        }
    ]
}

Получение списка наименований команд участников через API: get_user_groups

Пример get_user_groups запроса

https://your-domain.com/api/admin/v2/?action=get_user_groups&hash=HASH
Возвращает данные с наименованиями команд, их уникальные id и тип команды
В этом запросе параметр page не требуется

Пример JSON ответа

{
    "status": "ok",
    "data": [
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "company",
            "client": 0
        },
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "company",
            "client": 1
        }
    ]
}
В ответе указан тип команды:
  • "client": 0 – Моя команда
  • "client": 1 – Команда клиент

Получение списка наименований папок для контактов через API: get_contact_groups

Пример get_contact_groups запроса

https://your-domain.com/api/admin/v2/?action=get_contact_groups&hash=HASH
Возвращает данные с наименованиями папок, их уникальные id и тип папки
В этом запросе параметр page не требуется

Пример JSON ответа

{
    "status": "ok",
    "data": [
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "preset"
        },
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "folder"
        }
    ]
}
В ответе указанный тип:
  • "type": "preset" – папка для контактов, создана по умолчанию
  • "type": "folder" – папка для контактов, создана участником аккаунта

Создание папки для контактов через API: add_contact_group

Пример add_contact_group запроса

https://your-domain.com/api/admin/v2/?action=add_contact_group&
title=CONTACT_GROUP&hash=HASH
Проверяет на возможное существование такой папки, и создает новую, если необходимо.
В этом запросе параметр page не требуется

Обязательные параметры:
  • title – название папки для контактов

При успешном выполнении, ответ будет содержать статус ok и данные

{
    "status": "ok",
    "data": {
        "id": "CONTACT_GROUP_ID",
        "title": "CONTACT_GROUP",
        "type": "folder"
    }
}
esc
или
Распечатать