Retrieve a contact

Retrieve a single contact.

Single contact

GET https://{{account_id}}.acquire.io/api/v1/crm/objects/contact/{{contactId}}

Retrieve data for a single contact. The contactId must be passed in to the endpoint as a path parameter.

Path Parameters

Name
Type
Description

contactId*

integer

ID of the contact

Query Parameters

Name
Type
Description

select

string

Can be one of id|clientName|clientType|clientVersion| dateUpdated|dateCreated|clientOsName| clientOsVersion|clientDeviceType| clientDeviceVendor|clientDeviceModel| clientDetails|companyId

relations

string

Can be one of company | cases | fields | tags | visits | timeline

Headers

Name
Type
Description

Authorization*

string

Bearer {{API_KEY}}

{
    "data": {
        "dateCreated": "2020-08-11T07:25:59.000Z",
        "dateUpdated": "2020-08-11T07:27:14.000Z",
        "id": 1,
        "clientType": "web",
        "clientName": "Chrome",
        "clientVersion": "84.0",
        "clientOsName": "Windows",
        "clientOsVersion": "10",
        "clientDeviceType": null,
        "clientDeviceVendor": null,
        "clientDeviceModel": null,
        "clientDetails": {
            "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.105 Safari/537.36",
            "engine": {
                "name": "Blink",
                "version": "84.0.4147.105"
            },
            "network": {
                "type": "3g",
                "speed": "2.52"
            }
        },
        "archive": "no",
        "company": {
            "dateCreated": "2020-08-11T07:26:24.000Z",
            "dateUpdated": null,
            "id": 1,
            "fields": {
                "name": "Yahoo!",
                "website": "yahoo.com",
                "logo": "https://organization.acquire.io/logo/yahoo.com.png"
            }
        },
        "cases": [
            {
                "dateCreated": "2020-08-11T07:26:23.000Z",
                "dateUpdated": "2020-08-11T07:26:28.000Z",
                "id": 1,
                "contactId": 1,
                "closedBy": null,
                "visitId": 1,
                "title": "test : ",
                "description": "",
                "channel": "chat",
                "status": "active",
                "closingState": "handled",
                "dateQueue": "2020-08-11T07:26:23.000Z",
                "datePending": "2020-08-11T07:26:23.000Z",
                "dateActive": "2020-08-11T07:26:28.000Z",
                "dateClosed": null,
                "queueId": null,
                "queueOrder": null,
                "parentId": null,
                "userId": null,
                "waitTime": 0,
                "users": [
                    {
                        "id": 2,
                        "caseId": 1,
                        "type": "user",
                        "userId": 1,
                        "role": "owner",
                        "status": "active",
                        "dateCreated": "2020-08-11T07:26:22.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    },
                    {
                        "id": 3,
                        "caseId": 1,
                        "type": "user",
                        "userId": 6,
                        "role": "owner",
                        "status": "rejected",
                        "dateCreated": "2020-08-11T07:26:22.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    },
                    {
                        "id": 4,
                        "caseId": 1,
                        "type": "user",
                        "userId": 7,
                        "role": "owner",
                        "status": "rejected",
                        "dateCreated": "2020-08-11T07:26:22.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    },
                    {
                        "id": 5,
                        "caseId": 1,
                        "type": "user",
                        "userId": 8,
                        "role": "owner",
                        "status": "rejected",
                        "dateCreated": "2020-08-11T07:26:22.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    },
                    {
                        "id": 6,
                        "caseId": 1,
                        "type": "user",
                        "userId": 9,
                        "role": "owner",
                        "status": "rejected",
                        "dateCreated": "2020-08-11T07:26:22.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    },
                    {
                        "id": 7,
                        "caseId": 1,
                        "type": "user",
                        "userId": 10,
                        "role": "owner",
                        "status": "rejected",
                        "dateCreated": "2020-08-11T07:26:22.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    },
                    {
                        "id": 1,
                        "caseId": 1,
                        "type": "contact",
                        "userId": 1,
                        "role": "owner",
                        "status": "active",
                        "dateCreated": "2020-08-11T07:26:22.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    }
                ],
                "threadId": 1
            },
            {
                "dateCreated": "2020-08-11T07:27:14.000Z",
                "dateUpdated": "2020-08-11T07:27:19.000Z",
                "id": 2,
                "contactId": 1,
                "closedBy": null,
                "visitId": 2,
                "title": "test : ",
                "description": "",
                "channel": "chat",
                "status": "active",
                "closingState": "handled",
                "dateQueue": "2020-08-11T07:27:14.000Z",
                "datePending": "2020-08-11T07:27:14.000Z",
                "dateActive": "2020-08-11T07:27:18.000Z",
                "dateClosed": null,
                "queueId": null,
                "queueOrder": null
                "parentId": null,
                "userId": null,
                "waitTime": 0,
                "users": [
                    {
                        "id": 9,
                        "caseId": 2,
                        "type": "user",
                        "userId": 1,
                        "role": "owner",
                        "status": "active",
                        "dateCreated": "2020-08-11T07:27:13.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    },
                    {
                        "id": 10,
                        "caseId": 2,
                        "type": "user",
                        "userId": 6,
                        "role": "owner",
                        "status": "rejected",
                        "dateCreated": "2020-08-11T07:27:13.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    },
                    {
                        "id": 11,
                        "caseId": 2,
                        "type": "user",
                        "userId": 7,
                        "role": "owner",
                        "status": "rejected",
                        "dateCreated": "2020-08-11T07:27:13.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    },
                    {
                        "id": 12,
                        "caseId": 2,
                        "type": "user",
                        "userId": 8,
                        "role": "owner",
                        "status": "rejected",
                        "dateCreated": "2020-08-11T07:27:13.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    },
                    {
                        "id": 13,
                        "caseId": 2,
                        "type": "user",
                        "userId": 9,
                        "role": "owner",
                        "status": "rejected",
                        "dateCreated": "2020-08-11T07:27:13.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    },
                    {
                        "id": 14,
                        "caseId": 2,
                        "type": "user",
                        "userId": 10,
                        "role": "owner",
                        "status": "rejected",
                        "dateCreated": "2020-08-11T07:27:13.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    },
                    {
                        "id": 8,
                        "caseId": 2,
                        "type": "contact",
                        "userId": 1,
                        "role": "owner",
                        "status": "active",
                        "dateCreated": "2020-08-11T07:27:13.000Z",
                        "dateLastAssigned": "2020-10-15T09:01:54.000Z",
                        "closed": "no"
                    }
                ],
                "threadId": 2
            }
        ],
        "fields": {
            "name": "test",
            "email": "test@yahoo.com",
            "phone": "1343435454545",
            "city": "Sikar",
            "state": "Rajasthan",
            "country": {
                "name": "India",
                "name_official": "Republic of India",
                "cca2": "IN",
                "ccn3": "35",
                "cca3": "IND",
                "calling_code1": 91,
                "region_id": 366,
                "lat": "20",
                "lng": "77",
                "voip_enable": true
            },
            "countryId": "387",
            "ip": "157.37.227.248"
        }
    }
}

Last updated