Skip to main content
GET
/
v1
/
agents
List agents
curl --request GET \
  --url https://api.helpdesk.com/v1/agents \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://api.helpdesk.com/v1/agents"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.helpdesk.com/v1/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://api.helpdesk.com/v1/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: Basic <encoded-value>"
],
]);

$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://api.helpdesk.com/v1/agents"

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

req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.helpdesk.com/v1/agents")
.header("Authorization", "Basic <encoded-value>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.helpdesk.com/v1/agents")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
[
  {
    "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
    "licenseID": 13381337,
    "createdAt": "2026-06-30T22:02:08.901Z",
    "createdBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
    "createdByType": "agent",
    "updatedAt": "2026-06-30T22:02:08.901Z",
    "updatedBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
    "roles": [
      "owner"
    ],
    "teamIDs": [
      "f56caf69-3f05-4386-9567-fdc909d7ad77"
    ],
    "email": "john@helpdesk.com",
    "name": "John Text",
    "status": "active",
    "avatar": "https://livechat.s3.amazonaws.com/1520/avatars/c17903a3abff472f4b36ac33187cc135.jpeg",
    "flags": {
      "visitedWelcomeTutorial": true
    },
    "settings": {
      "emailNotificationsActive": true,
      "webpushNotificationsActive": "always"
    },
    "autoassignment": true,
    "autoassignmentTeamIDs": [
      "9dd9e888-b42e-46c1-aa63-20cb5354c28c"
    ],
    "signature": {
      "text": "Best regards,\nJohn // Text, Inc.\n",
      "richTextObj": [
        {
          "type": "paragraph"
        },
        {
          "children": [
            {
              "text": "Best regards,"
            },
            {
              "type": "paragraph"
            },
            {
              "children": null
            },
            {
              "text": "Jogn // Text, Inc."
            }
          ]
        }
      ],
      "attachments": []
    }
  }
]

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Response

200 - application/json

Successful response.

ID
string<uuid>

Unique object identifier.

licenseID
integer

Unique account identifier.

createdAt
string<date-time>

The time of creation.

createdBy
string<uuid>

The creator identifier.

createdByType
enum<string>

The creator type.

Available options:
agent,
client,
system
updatedAt
string<date-time>

The time of last modification.

updatedBy
string<uuid>

The modification author identifier.

roles
enum<string>[]

Agent role

Available options:
owner,
normal,
viewer
teamIDs
string[]

A list of teams that agent is a member of.

email
string

The agent's email.

name
string

The full name.

status
enum<string>

The account status.

Available options:
active,
invited
avatar
string

The avatar URL.

jobTitle
string

The job title.

flags
object
settings
object
autoassignment
boolean

Enable autoassignment for the agent.

autoassignmentTeamIDs
string[]

A list of teams from which an agent can be auto-assigned.

signature
object