LogoLogo
WebsiteGuide & TutorialBlogBook a Demo
1.0.0
1.0.0
  • Acquire Developers Hub
  • Acquire
    • Acquire Build Requirement
      • Requirement For Acquire
      • Acquire Speedtest
  • JS API
    • JS Live Chat API
      • Description
      • Installation
      • Visitor
      • Thread
      • Conversation
      • User Verification
    • Quick Link Support
      • One Click Button
      • Social Media Share
    • Backend JS SDK
      • Setup Backend JS SDK
      • Demo Backend SDK
    • Advanced
      • Widget UI
      • Reference
  • Co Browse APIs
    • Acquire Co Browse
      • Co Browse API
  • Acquire API Events
    • WebRTC Related Events
  • iOS
    • SDK Setup Guide
      • Getting Started
      • Integration Guide (Core)
      • Integration Guide (Lite)
      • Manual Setup iOS
      • Acquire Account ID
    • SDK Configuration Example
    • iOS Cobrowse
    • Theme Setting
    • iOS Push Notifications
    • Verify your users
  • Android
    • Getting Started
      • Integration Guide (Core)
      • Integration Guide (Lite)
      • Start using Acquire
    • Acquire APIs
    • Acquire Delegates
    • Custom UI/widget
    • Cross Platform Integrations
  • Webhook API
    • Webhooks Basic
      • Introduction
      • Webhook Integrate Steps
      • Webhook Format
    • Webhook Events
      • On Chat Start
      • On Chat Accept
      • On Chat Message
      • On Chat Close
  • REST APIs
    • OAuth
      • Authorization
      • Tracklog
    • Profiles API
      • Profile List
      • Thread
      • Feedback
      • Profile Details
      • Message
      • Tags
      • Profile Agents
      • Campaigns
      • Profile Add Update
      • Profile Delete
      • Profile Visit History
      • Sender Emails
    • Chat
      • Chat Notes
    • Analytics
      • Chat Statistics
      • Team Analytics
      • Conversion Rate
      • Chat Tag
      • Co browsing
    • Agent
      • Agents List
      • Agent add
      • Edit / Get-agent
      • Update
    • Trigger
      • Triggers List
      • Triggers Detail
    • Operating Hours
      • Save Operating Hours
      • Get Operating Hours
    • Cobrowse
  • Chatbot API
    • Chat Bot
      • Integrate Your Chatbot
      • Dialog Flow V1 Chat-Bot
      • Dialog Flow V2 Chat-Bot
      • Dialog Flow Fulfillment & Custom Response
      • IBM Watson Integration
      • Amazon Lex Bot
      • Azure's QnA Maker
      • Webhook Calling & User Verification
      • Webhook For Reset Password
  • Knowledge Base APIs
    • Help Docs Setup
      • Get FAQ Categories
      • Get Setup Details
      • Get Side List
      • Get Article
      • Get Recent Article
      • Get Categorized Articles
      • Get Suggestion
  • Errors
    • API Error Handling
      • HTTP Responses
Powered by GitBook
On this page
  1. REST APIs
  2. Agent

Agents List

PreviousAgentNextAgent add

Last updated 5 years ago

Using acquire agent API for agents all details and get activities. You can do setup acquire backend on your own dashboard easily use this. Agent List API in all agents details available. Acquire Agent List API in you can get agent's 'secret_key' and use anywhere but make sure secure this.

Get Auth Token

We provide an Access Token as soon as you create an app on your workspace. First login Acquire dashboard and Go Setting > API Token and Whitelist > API Token ( ). Copy API token and use API header in auth_token parameter. If you want to new token generate click on button "Generate New Token".

Your Access Token can give access to your private Acquire data and should be treated like a password. If an app provider asks you for your Access Token, please do not provide it. Instead, let us know - apps are required to use OAuth rather than asking users for Access Tokens.

API auth token [YOUR_API_AUTH_TOKEN] do not use public and make sure secure.

If you want to use auth token in API for makes a own dashboard then save anywhere secure and use server side.

Parameter

Value

Path

https://app.acquire.io/api/account/agents

Method

POST

Authorization

Bearer [YOUR_API_AUTH_TOKEN]

Content-type

application/json

Body (row)

{"page":1,"limit":25,"sort_by":{"key":"","order":""}}

Response JSON

{
    "success": true,
    "error": null,
    "data": {
        "rows": [
            {
                "id": 14755,
                "user_id": 15022,
                "account_id": 10111,
                "user_name": "David",
                "user_email": "davidklok@acquire.io",
                "allowed_ip": "",
                "role": 1,
                "role_name": "Administrator",
                "role_status": "active",
                "user_status": "active",
                "secret_key": "[SECRET KEY]",
                "user_type": "Zapier",
                "department_id": null,
                "department_name": null
            }
        ],
        "count": 1,
        "page": 1,
        "limit": 25
    }
}

Sample Code

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://app.acquire.io/api/account/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{"page":"","limit":"","sort_by":{"key":"","order":""}}",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer [TOKEN]",
    "Content-Type: application/json",
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
require 'uri'
require 'net/http'

url = URI("https://app.acquire.io/api/account/agents")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer [TOKEN]]'
request["Content-Type"] = 'application/json'
request.body = "{\"page\":\"\",\"limit\":\"\",\"sort_by\":{\"key\":\"\",\"order\":\"\"}}"

response = http.request(request)
puts response.read_body
curl -X POST \
  https://app.acquire.io/api/account/agents \
  -H 'Authorization: Bearer [TOKEN]' \
  -H 'Content-Type: application/json' \
  -d '{"page":"","limit":"","sort_by":{"key":"","order":""}}'
 var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://app.acquire.io/api/account/agents",
  "method": "POST",
  "headers": {
    "Authorization": "Bearer [TOKEN]",
    "Content-Type": "application/json",
  },
  "processData": false,
  "data": "{\"page\":\"\",\"limit\":\"\",\"sort_by\":{\"key\":\"\",\"order\":\"\"}}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
import requests

url = "https://app.acquire.io/api/account/agents"

payload = "{\"page\":\"\",\"limit\":\"\",\"sort_by\":{\"key\":\"\",\"order\":\"\"}}"
headers = {
    'Authorization': "Bearer [TOKEN]]",
    'Content-Type': "application/json",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.acquire.io/api/account/agents',
  headers: 
   {'Content-Type': 'application/json',
     Authorization: 'Bearer [TOKEN]' },
  body: { page: '', limit: '', sort_by: { key: '', order: '' } },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

https://app.acquire.io/setting/token