Get your company's agents

Returns the agents in your account that can receive conversations. Use it to find out each agent’s id and email, which are the values you must return from your endpoint when using the API destination of the Transfer Methods block.

Only active agents are returned, so any agent in the response can receive a conversation.

This endpoint lives on the agent platform host, agent-api.treble.ai, and not on main.treble.ai.

GET /agent/company/agents

Get your company's agents

cURL

curl --request GET \
  --url https://agent-api.treble.ai/agent/company/agents \
  --header 'Authorization: <authorization>'

import requests

url = "https://agent-api.treble.ai/agent/company/agents"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://agent-api.treble.ai/agent/company/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://agent-api.treble.ai/agent/company/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://agent-api.treble.ai/agent/company/agents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://agent-api.treble.ai/agent/company/agents")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://agent-api.treble.ai/agent/company/agents")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

200

[
  {
    "id": 4567,
    "first_name": "Andrea",
    "last_name": "Soto",
    "email": "[e-mail]",
    "tags": [
      {
        "id": 12,
        "name": "Default"
      },
      {
        "id": 18,
        "name": "Comercial"
      }
    ]
  }
]

Headers

Authorization · string · required

Authorization API Key. It can be obtained at https://app.treble.ai/en/dashboard/settings/developers

Response

200 - application/json

Agent list retrieved successfully

id · integer

The agent's identifier in Treble. It's the recommended value to return from your assignment endpoint.

Example:

4567

first_name · string

The agent's first name.

Example:

"Andrea"

last_name · string

The agent's last name.

Example:

"Soto"

email · string

The agent's email, as registered in Treble. Your assignment endpoint can also return it instead of the id.

Example:

"[e-mail]"

tags · object[]

Teams the agent belongs to.

Show child attributes