WORKSECTION

Member

Getting the list of users through API: get_users

Sample get_users request

https://your—domain.com/api/admin/v2/?action=get_users&hash=HASH
Returns account users data
This request does not require 
page parameter

Returned data:
  • id — unique user identifier
  • first_name — user first name
  • last_name — user last name
  • name — user first and last name
  • title — user position
  • avatar — link to the user avatar image
  • group — team name
  • department — department name
  • role — user role: owner, account admin, team admin, department admin, user, guest, reader
  • email — user email
  • phone — phone number (if specified)
  • phone2 — office phone number (if specified)
  • phone3 — mobile phone number (if specified)
  • phone4 — home phone number (if specified)
  • address — address (if specified)
  • address2 — additional address (if specified)

Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

{
    "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", ... ... ...
}
    ]
}

Adding a new user to the account through API: add_user

Sample add_user request

https://your—domain.com/api/admin/v2/?action=add_user&
email=USER_EMAIL&hash=HASH
A new user will be invited to the account (to the main team if group parameter is not specified)
This request does not require page parameter

Required parameters:
  • email — user email

Optional parameters:
  • first_name — user first name
  • last_name — user last name
  • title — user position
  • group — team name
  • department — department name
  • role — user role. Available options: user, guest and reader

Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

{
    "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"
    }
}

Subscribing a user to a task through API: subscribe

Sample subscribe request

https://your-domain.com/api/admin/v2/?action=subscribe&
page=/project/PROJECT_ID/TASK_ID/&email_user=USER_EMAIL&hash=HASH 
Required parameters:
  • email_user — user email, who needs to be subscribed to a task
  • page — task link (see link format for details)

Sample JSON response
If the request succeeds, the response will contain ok status

{
    "status": "ok"
}

Unsubscribing a user from a task through API: unsubscribe

Sample unsubscribe request

https://your-domain.com/api/admin/v2/?action=unsubscribe&
page=/project/PROJECT_ID/TASK_ID/&email_user=USER_EMAIL&hash=HASH 
Required parameters:
  • email_user — user email, who needs to be unsubscribed from a task
  • page — task link (see link format for details)

Sample JSON response
If the request succeeds, the response will contain ok status

{
    "status": "ok"
}

Creating a contact through API: add_contact

Sample add_contact request

https://your—domain.com/api/admin/v2/?action=add_contact&
name=CONTACT_NAME&email=CONTACT_EMAIL&hash=HASH 
The contact does not receive an invitation to the account!
This request does not require page parameter

Required parameters:
  • email — email of the contact
  • name — first and last name of the contact

Optional parameters of the contact:
  • title — position
  • group — folder name
  • phone — phone number
  • phone2 — office phone number
  • phone3 — mobile phone number
  • phone4 — home phone number
  • address — address
  • address2 — additional address

Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

{
    "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"
    }
}

Creating a team for account users through API: add_user_group

Sample add_user_group request 

https://your-domain.com/api/admin/v2/?action=add_user_group&
title=USER_GROUP&hash=HASH
Checks for the possible existence of such team and creates a new one if necessary
This request does not require page parameter

Required parameters:
  • title — team name

Optional parameters:
  • client 1 for an external client team and 0 for your company team

Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

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

Getting the list of contacts through API: get_contacts

Sample get_contacts request

https://your—domain.com/api/admin/v2/?action=get_contacts&hash=HASH
Returns account contacts data
This request does not require 
page parameter

Returned data of contacts:
  • id — unique contact identifier
  • first_name — first name
  • last_name — last name
  • name — first and last name
  • title — position
  • group — folder name
  • email — email of the contact
  • phone — phone number (if specified)
  • phone2 — office phone number (if specified)
  • phone3 — mobile phone number (if specified)
  • phone4 — home phone number (if specified)
  • address — address (if specified)
  • address2 — additional address (if specified)

Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

{
    "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"
        }
    ]
}

Getting the list of user team names through API: get_user_groups

Sample get_user_groups request

https://your-domain.com/api/admin/v2/?action=get_user_groups&hash=HASH
Returns data on account user teams
This request does not require page parameter

Returned data:
  • id — unique team identifier
  • title — team name
  • client — team type:
0 — your company team
1 — external client team

Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

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

Getting the list of contact folder names through API: get_contact_groups

Sample get_contact_groups request

https://your-domain.com/api/admin/v2/?action=get_contact_groups&hash=HASH
Returns data on account contact folders
This request does not require page parameter

Returned data:
  • id — unique folder identifier
  • title — folder name
  • type — folder type:
preset — contact folder, created by default
folder — contact folder, created by an account user

Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

{
    "status": "ok",
    "data": [
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "preset"
        },
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME",
            "type": "folder"
        }
    ]
}

Creating a contact folder through API: add_contact_group

Sample add_contact_group request

https://your-domain.com/api/admin/v2/?action=add_contact_group&
title=CONTACT_GROUP&hash=HASH
Checks for the possible existence of such folder and creates a new one if necessary
This request does not require page parameter

Required parameters:
  • title — folder name for contacts

Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

{
    "status": "ok",
    "data": {
        "id": "CONTACT_GROUP_ID",
        "title": "CONTACT_GROUP",
        "type": "folder"
    }
}
esc
или
Print