Knowledge base - Getting the list of contacts through API: get

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

Getting the list of contacts through API: get_contacts