Get Omnichannel Contact

Retrieves a contact information.

Retrieve a contact's information.

HTTP Method	URL	Requires Auth
GET	api/v1/omnichannel/contact	yes

Query Parameters

Key	Example Value	Description
contactId *	mAm5YZHwHMrNj8fhu	The contact ID.

Example Call

curl --location 'http://localhost:3000/api/v1/omnichannel/contact?contactId=653f9ce1a2f73c7460e18e82' \
--header 'X-Auth-Token: b5BKhblglC5OU0AfB_Tl9dKmOb0zXUvWK-nhNT_aE8V' \
--header 'X-User-Id: CkCPNcvsvCDfmWLqC'

Example Response

{
    "contact": {
        "_id": "653f9ce1a2f73c7460e18e82",
        "username": "guest-39",
        "ts": "2023-10-30T12:09:05.982Z",
        "token": "434lxd7iss8yh8c4m80wh",
        "_updatedAt": "2023-10-30T13:43:22.044Z",
        "contactManager": {
            "username": "kim.jane"
        },
        "livechatData": {},
        "name": "Chris",
        "phone": [
            {
                "phoneNumber": "[phone]"
            }
        ],
        "visitorEmails": [
            {
                "address": "[e-mail]"
            }
        ]
    },
    "success": true
}