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. Company

List all companies

Lists all companies in the account.

All Companies

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

This API can be used to retrieve a list of companies with contact objects.

Query Parameters

Name
Type
Description

limit

string

The number of results e.g. 20

where

array

Format : column|expression|value columns

e.g. id|eq|12

select

array

Can be one of dateCreated | dateUpdated | id | parent

relations

array

Can be one of contacts | fields | parent | companies

Headers

Name
Type
Description

Authorization*

string

Bearer {{API_KEY}}

{
    "data": {
        "page": 0,
        "offset": 0,
        "limit": 20,
        "count": 5,
        "data": [
            {
                "dateCreated": "2020-08-11T11:07:46.000Z",
                "dateUpdated": "2020-08-11T11:07:46.000Z",
                "id": 1,
                "parent": null,
                "companies": [],
                "contacts": [
                    {
                        "dateCreated": "2020-05-22T06:04:45.000Z",
                        "dateUpdated": "2020-08-11T11:07:46.000Z",
                        "id": 77,
                        "clientType": "web",
                        "clientName": "Chrome",
                        "clientVersion": "83.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/83.0.4103.116 Safari/537.36",
                            "engine": {
                                "name": "Blink",
                                "version": "83.0.4103.116"
                            },
                            "network": {
                                "type": "4g",
                                "speed": "16.56"
                            }
                        },
                        "companyId": 1,
                        "fields": {
                            "name": "Surendra Sutahr",
                            "email": "surendra@docusign.com",
                            "city": "Jaipur",
                            "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.236.36"
                        },
                        "objectCounts": {
                            "totalCases": 3,
                            "totalNotes": 0,
                            "totalViews": 3
                        }
                    }
                ],
                "fields": {
                    "name": "new company"
                }
            },
            {
                "dateCreated": "2020-08-12T07:06:24.000Z",
                "dateUpdated": null,
                "id": 2,
                "parent": null,
                "companies": [],
                "contacts": [
                    {
                        "dateCreated": "2020-08-10T08:32:48.000Z",
                        "dateUpdated": "2020-08-12T07:06:19.000Z",
                        "id": 78,
                        "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": "4g",
                                "speed": "1.62"
                            }
                        },
                        "companyId": 2,
                        "fields": {
                            "email": "test@facebook.com",
                            "city": "Jaipur",
                            "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.148.6"
                        },
                        "objectCounts": {
                            "totalCases": 0,
                            "totalNotes": 0,
                            "totalViews": 1
                        }
                    }
                ],
                "fields": {
                    "name": "Facebook",
                    "website": "facebook.com",
                    "logo": "https://organization.uat.env.acquire.io/logo/facebook.com.png"
                }
            },
            {
                "dateCreated": "2020-09-09T10:02:01.000Z",
                "dateUpdated": null,
                "id": 3,
                "parent": null,
                "companies": [],
                "contacts": [
                    {
                        "dateCreated": "2020-09-09T10:01:36.000Z",
                        "dateUpdated": "2020-09-09T10:01:58.000Z",
                        "id": 82,
                        "clientType": "web",
                        "clientName": "Chrome",
                        "clientVersion": "85.0",
                        "clientOsName": "Windows",
                        "clientOsVersion": "10",
                        "clientDeviceType": "Desktop",
                        "clientDeviceVendor": null,
                        "clientDeviceModel": null,
                        "clientDetails": {
                            "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.83 Safari/537.36",
                            "engine": {
                                "name": "Blink",
                                "version": "85.0.4183.83"
                            },
                            "network": {
                                "type": "4g",
                                "speed": "18"
                            }
                        },
                        "companyId": 3,
                        "fields": {
                            "name": "test",
                            "email": "test@gmailc.om",
                            "phone": "23232323",
                            "city": "Kanpur",
                            "state": "Uttar Pradesh",
                            "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": "112.196.188.108"
                        },
                        "objectCounts": {
                            "totalCases": 1,
                            "totalNotes": 0,
                            "totalViews": 0
                        }
                    }
                ],
                "fields": {
                    "name": "Gmail",
                    "website": "gmailc.om",
                    "logo": null,
                    "industry": null,
                    "description": null,
                    "source": null,
                    "address": null,
                    "employees": null,
                    "foundation": null
                }
            },
            {
                "dateCreated": "2020-09-10T11:44:05.000Z",
                "dateUpdated": "2020-09-10T11:44:05.000Z",
                "id": 4,
                "parent": null,
                "companies": [],
                "contacts": [],
                "fields": {
                    "name": "new company"
                }
            },
            {
                "dateCreated": "2020-09-10T11:44:05.000Z",
                "dateUpdated": "2020-09-10T11:49:52.000Z",
                "id": 5,
                "parent": null,
                "companies": [],
                "contacts": [],
                "fields": {
                    "name": "Zery",
                    "website": "zery.com",
                    "industry": "IT",
                    "description": "No description ",
                    "source": "No source added",
                    "revenue": "100000",
                    "city": "SF",
                    "state": "california",
                    "country": {
                        "name": "United States",
                        "name_official": "United States of America",
                        "cca2": "US",
                        "ccn3": "84",
                        "cca3": "USA",
                        "calling_code1": 1,
                        "region_id": 496,
                        "lat": "38",
                        "lng": "-97",
                        "voip_enable": true
                    },
                    "countryId": "517",
                    "address": "SF, california",
                    "employees": "50-100",
                    "foundation": "2020"
                }
            }
        ]
    }
}
PreviousCompanyNextRetrieve a company

Last updated 3 years ago