WORKSECTION

Members

Getting the list of users through API: get_users

Sample get_users request

?action=get_users
Returns account users info
Returned data:
  • id — user ID
  • first_name — user first name
  • last_name — user last name
  • name — user first and last name
  • title — user position
  • url — user url address
  • services — object with two nested objects: chats (messengers) и socials (social networks)
  • contacts — info from "Other contacts" field
    *not returned if empty
  • data_added — date and time invitation sent to user
    *returned if using admin token
  • rate — user rate (if specified)
  • avatar — link to the user avatar image
  • group — team name
  • department — department name
  • role — user role, possible values: owner, account admin, team admin, department admin, user, guest, reader
  • email — user email
  • phone — main 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",
            "url": "CONTACT_URL",
            "services": {
                "chats": {
                    "WhatsApp": "...",
                    ... ... ...
                },
                "socials": {
                    "LinkedIn": "...",
                    ... ... ...
                }
            },
            "contacts": "CONTACT_OTHER_CONTACTS",
            "date_added": "YYYY-MM-DD HH:MM",
            "rate": USER_RATE,
            "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",
            ... ... ...
        }
    ]
}
Was this article helpful? Yes, thank you! No

Adding a new user to the account through API: add_user

Sample add_user request

?action=add_user&email=USER_EMAIL
Invites new account user
*into your team if group parameter is not specified

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, possible values: 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",
        "rate": USER_RATE,
        "avatar": "URL",
        "group": "GROUP_NAME",
        "department": "USER_DEPARTMENT",
        "role": "USER_ROLE",
        "email": "USER_EMAIL"
    }
}
Was this article helpful? Yes, thank you! No

Getting the list of user team names through API: get_user_groups

Sample get_user_groups request

?action=get_user_groups
Returns account user teams list
Returned data:
  • id — team ID
  • 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
        }
    ]
}
Was this article helpful? Yes, thank you! No

Creating a team for account users through API: add_user_group

Sample add_user_group request 

?action=add_user_group&title=USER_GROUP
Creates account user team
*if there are no teams with same name

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_NAME",
        "type": "company",
        "client": 1
    }
}
Was this article helpful? Yes, thank you! No

Getting the list of contacts through API: get_contacts

Sample get_contacts request

?action=get_contacts
Returns account contacts info
Returned data of contacts:
  • id — contact ID
  • first_name — first name
  • last_name — last name
  • name — first and last name
  • title — position
  • url — url address
  • services — object with two nested objects: chats (messengers) и socials (social networks)
  • contacts — info from "Other contacts" field
    *not returned if empty
  • data_added — date and time added
    *returned if using admin token
  • group — folder name
  • email — contact email
  • phone — main 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",
            "url": "CONTACT_URL",
            "services": {
                "chats": {
                    "WhatsApp": "...",
                    ... ... ...
                },
                "socials": {
                    "LinkedIn": "...",
                    ... ... ...
                }
            },
            "contacts": "CONTACT_OTHER_CONTACTS",
            "date_added": "YYYY-MM-DD HH:MM",
            "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"
        },
        {
            "id": "CONTACT_ID",
            "first_name": "CONTACT_FIRST_NAME",
            "last_name": "CONTACT_LAST_NAME",
            ... ... ...
        }
    ]
}
Was this article helpful? Yes, thank you! No

Creating a contact through API: add_contact

Sample add_contact request

?action=add_contact&name=CONTACT_NAME&email=CONTACT_EMAIL
Creates new account contact
*no invitation sent

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

Optional parameters of the contact:
  • title — position
  • group — folder name
  • phone — main 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"
    }
}
Was this article helpful? Yes, thank you! No

Getting the list of contact folder names through API: get_contact_groups

Sample get_contact_groups request

?action=get_contact_groups
Returns account contact folders list
Returned data:
  • id — folder ID
  • title — folder name
  • type — folder type:
preset — contact folder, created by default
folder — contact folder, created by 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"
        }
    ]
}
Was this article helpful? Yes, thank you! No

Creating a contact folder through API: add_contact_group

Sample add_contact_group request

?action=add_contact_group&title=CONTACT_GROUP
Creates account contacts folder
*if there are no folders with same name

Required parameters:
  • title — contacts folder name
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"
    }
}
Was this article helpful? Yes, thank you! No

Subscribing a user to a task through API: subscribe

Sample subscribe request

?action=subscribe&id_task=TASK_ID&email_user=USER_EMAIL
Subscribes user to selected task
*task subscribers list can be obtained through get_task method with extra=subscribers parameter

Required parameters:
  • id_task — task ID
  • email_user — user email
Sample JSON response
If the request succeeds, the response will contain ok status

{
    "status": "ok"
}

Was this article helpful? Yes, thank you! No

Unsubscribing a user from a task through API: unsubscribe

Sample unsubscribe request

?action=unsubscribe&id_task=TASK_ID&email_user=USER_EMAIL
Unsubscribes user from selected task
*task subscribers list can be obtained through get_task method with extra=subscribers parameter

Required parameters:
  • id_task — task ID
  • email_user — user email
Sample JSON response
If the request succeeds, the response will contain ok status

{
    "status": "ok"
}

Was this article helpful? Yes, thank you! No

Getting the authorized user info through API: me

Sample me request

?action=me
Returns info about authorized user (oauth2)

method available only for access token
Returned data:
  • id — user ID
  • 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, possible values: owner, account admin, team admin, department admin, user, guest, reader
  • email — user email
  • phone — main 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",
            "rate": USER_RATE,
            "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"
        }
    ]
}
Was this article helpful? Yes, thank you! No
esc
или
Print