WORKSECTION

Участник

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

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

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

Возвращаемые данные:
  • id — уникальный номер пользователя
  • first_name — имя пользователя
  • last_name — фамилия пользователя
  • name — имя и фамилия пользователя
  • title — должность пользователя
  • avatar — ссылка на изображение аватарки пользователя
  • group — название команды
  • department — название отдела
  • role — роль пользователя:
  • owner — владелец
    account admin — администратор аккаунта
    team admin — администратор команды
    department admin — администратор отдела
    user — пользователь
    guest — гость
    reader — читатель 
  • email — email пользователя
  • phone — номер телефона (если указано)
  • phone2 — рабочий номер телефона (если указано) 
  • phone3 — мобильный номер телефона (если указано) 
  • phone4 — домашний номер телефона (если указано) 
  • address — адрес (если указано) 
  • address2 — второй адрес (если указано) 

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

{
    "status": "ok",
    "data": [
        {
            "id": "USER_ID",
            "first_name": "USER_FIRST_NAME_1",
            "last_name": "USER_LAST_NAME_1",
            "name": "USER_NAME",
            "title": "USER_POSITION",
            "avatar": "URL",
            "group": "USER_GROUP",
            "department": "USER_DEPARTMENT",
            "role": "USER_ROLE",
            "email": "USER_EMAIL",
            "phone": "USER_PHONE",
            "phone2": "USER_PHONE_2",
            "phone3": "USER_PHONE_3",
            "address": "USER_ADDRESS",
            "address2": "USER_ADDRESS_2"
        },
        {
            "id": "USER_ID",             "first_name": "USER_FIRST_NAME_2",             "last_name": "USER_LAST_NAME_2", ... ... ...
}
    ]
}

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

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

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

Обязательные параметры:
  • email — email пользователя

Необязательные параметры:
  • first_name — имя пользователя
  • last_name — фамилия пользователя
  • title — должность пользователя
  • group — название команды
  • department — название отдела
  • role — роль пользователя. Доступные варианты:
user — пользователь
guest — гость
reader — читатель 

Пример JSON ответа
При успешном выполнении запроса, ответ будет содержать статус 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_ROLE",
        "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 подписываемого пользователя
  • page — ссылка на задачу (см. формат ссылки)

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

{
    "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 отписываемого пользователя
  • page — ссылка на задачу (см. формат ссылки)

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

{
    "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 — рабочий номер телефона 
  • phone3 — мобильный номер телефона 
  • phone4 — домашний номер телефона 
  • address — адрес контакта
  • address2 — второй адрес контакта

Пример JSON ответа
При успешном выполнении запроса, ответ будет содержать статус 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",
        "phone2": "CONTACT_PHONE_2",
        "phone3": "CONTACT_PHONE_3",
        "phone4": "CONTACT_PHONE_4",
        "address": "CONTACT_ADDRESS",
        "address2": "CONTACT_ADDRESS_2"
    }
}

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

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

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

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

Необязательные параметры:
  • client 1 для клиентской команды и 0 для команды компании

Пример JSON ответа
При успешном выполнении, ответ будет содержать статус 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 не требуется

Возвращаемые данные:
  • id — уникальный номер контакта
  • first_name — имя контакта
  • last_name — фамилия контакта
  • name — имя и фамилия контакта
  • title — должность контакта
  • group — название папки контактов
  • email — email контакта
  • phone — номер телефона (если указано)
  • phone2 — рабочий номер телефона (если указано) 
  • phone3 — мобильный номер телефона (если указано) 
  • phone4 — домашний номер телефона (если указано) 
  • address — адрес (если указано) 
  • address2 — второй адрес (если указано) 

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

{
    "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",
            "phone2": "CONTACT_PHONE_2",
            "phone3": "CONTACT_PHONE_3",
            "phone4": "CONTACT_PHONE_4",
            "address": "CONTACT_ADDRESS",
            "address2": "CONTACT_ADDRESS_2"
        }
    ]
}

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

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

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

Возвращаемые данные:
  • id — уникальный номер команды
  • title — название команды
  • client — тип команды:
0 — внутренняя команда компании
1 — клиентская команда

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

{
    "status": "ok",
    "data": [
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "company",
            "client": 0
        },
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "company",
            "client": 1
        }
    ]
}

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

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

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

Возвращаемые данные:
  • id — уникальный номер папки
  • title — название папки
  • type — тип папки:
preset — папка для контактов, созданная по умолчанию
folder — папка для контактов, созданная участником аккаунта

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

{
    "status": "ok",
    "data": [
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "preset"
        },
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "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 — название папки для контактов

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

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