Agents List

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 ( https://app.acquire.io/setting/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;
}

Last updated