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: subscribe

Приклад 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_users

Приклад 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
или
Роздрукувати