List Agents

GET /api/agents

List Agents

cURL

curl --request GET \
  --url https://your-domain.com/api/agents

import requests

url = "https://your-domain.com/api/agents"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://your-domain.com/api/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://your-domain.com/api/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://your-domain.com/api/agents")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-domain.com/api/agents")

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

request = Net::HTTP::Get.new(url)

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

200

{
  "items": [
    "<unknown>"
  ],
  "total": 123,
  "page": 123,
  "size": 123,
  "pages": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Query Parameters

page · integer · default: 1

Required range: x >= 1

size · integer · default: 20

Required range: 1 <= x <= 100

status · string | null

Response

200

application/json

Successful Response

items · any[] · required

total · integer · required

page · integer · required

size · integer · required

pages · integer · required