Members

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

Last updated

Was this helpful?