LogoLogo
WebsiteGuide & TutorialBlogBook a Demo
2.0.0
2.0.0
  • Getting Started
  • Widget
    • Overview
    • Installation
    • Customization
      • Settings
        • Greeting
        • Greeting Introduction
        • Conversation button
        • Conversation list title
        • Launcher Text
        • Widget Appearance
      • Methods
        • Widget visibility
        • Widget window state
        • Set Customer Info
        • Get Customer info
      • Events/Callbacks
        • reloadUI
        • onChatMaximize
        • onChatMinimize
        • onChatInitiated/Started
        • onChatClosed
        • onAgentAssign
        • onAgentStateChange (Available/Unavailable)
      • Link resources
        • Share channel link
  • SDK
    • [Under Development] Overview
    • [Under Development] iOS
      • [Under Development] iOS Setup Guide
        • [Under Development] Getting Started
        • [Under Development] Integration Guide (Core)
        • [Under Development] Integration Guide (Lite)
      • [Under Development] Initialization
      • [Under Development] Theme Setting
      • [Under Development] Acquire Delegates for iOS
      • [Under Development] Widget customization
      • [Under Development] React Native
    • [Under Development] Android
      • [Under Development] Android Setup Guide
        • [Under Development] Getting Started
        • [Under Development] Integration Guide (Core)
        • [Under Development] Integration Guide (Lite)
      • [Under Development] Acquire SDK APIs
      • [Under Development] Acquire Delegates for Android
      • [Under Development] React Native
  • Webhooks
    • Introduction
    • Getting Started
    • Securing Webhook
    • Webhook Events
  • REST APIs
    • Introduction
      • Request Types, Permissions, Errors, & Limits
    • Authorization
    • Conversation
      • Cases
        • Messages
          • Retrieve a list of messages
          • Retrieve a message
          • Send a message
          • Update message
          • Delete Message
        • Case List
        • Single Case
        • Create
        • Close Case
        • Reopen Case
        • Invite Agent
      • Snooze
        • [Under Construction] Delete Snooze
        • Create Snooze
      • Notes
        • List all notes
        • Retrieve a note
        • Create
        • Add note message
        • Delete note
        • Retrieve note messages
    • Contact
      • List all contacts
      • Retrieve a contact
      • Add contact
      • Block Contact
      • Merge contact
      • Update contact
      • Delete contact
    • Company
      • List all companies
      • Retrieve a company
      • Add company
      • Update company
      • Delete company
    • Phone
      • Call in queue
      • Ringing
      • Answered
      • Call end
    • Chatbot
      • Conversational Bot
        • Groups
          • Get Default Group
          • List
          • Add
          • Delete
          • Copy
        • Question And Answer
          • List
          • Get
          • Add
          • Update
          • Delete
          • Publish
          • Bulk Action
          • Push QnA To Suggestions
          • Import QnA
      • Sequence Bot
        • Sequence List
        • Get Single Sequence
        • Add
        • Update
        • Delete
        • Bulk Action
        • Copy Existing Sequence
        • Branch
          • Get Single Branch
          • Add
          • Update
          • Delete
          • Set as Parent Branch
      • Bot resources
      • Webhooks in chatbot
    • Analytics
      • Custom Reporting
      • General Analytics
      • Chat
        • Overview
        • Tags
        • Visitor Information
          • Visitor Analytics
          • Visitor Source Overview
        • Video Analytics
      • Cobrowse
      • Chatbot
        • Sequence Bot
        • Conversational Bot
      • Knowledge Base
      • Email
      • VoIP - Call SMS
      • Agent Performance
    • [Under Construction] Custom Cards
      • Timeline-cards
        • Create Interaction Card
        • Update Interaction Card
        • List all Cards
        • Retrieve a card
        • Delete card
      • Exclusive cards
        • Create general card
        • Create app card - from other system
        • Delete card
    • Knowledge Base
      • Groups
        • Add
        • Update
        • Get
        • Get Single
        • Delete
      • Articles
        • Add Article
        • Update Article
        • Delete Article
        • Get Articles
        • Get Single Article
      • Category
        • Add Category
        • Update Category
        • Delete Category
        • Get Category
    • Settings
      • Account Settings
        • Users
          • List
          • Get Single
          • Add
          • Update
          • Delete
        • Roles
          • List
          • Get Single Role
          • Add
          • Update
          • Delete
        • Departments
          • List
          • Get
          • Add
          • Update
          • Delete
        • Custom Attributes
          • List of custom attributes
          • Get a custom Attribute
          • Add a custom attribute
          • Update a custom attribute
          • Delete a custom attribute
      • Conversation Settings
        • Shortcuts
          • List Groups
          • Get
          • Add
          • Update
          • Delete
        • Tags
          • List All Tags
          • Get Single Tag
          • Add New Tag
          • Update Tag
          • Delete Tag
        • Feedback
          • List of all feedback
          • Get single feedback
          • Add feedback
          • Update Feedback
          • Delete feedback
      • Security
        • Block Visitor
          • List
          • Get
          • Add
          • Delete
        • Audit Logs
          • Audit Log
          • Audit Log Users
Powered by GitBook
On this page
  1. REST APIs
  2. Contact

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"
        }
    }
}
PreviousList all contactsNextAdd contact

Last updated 3 years ago