Skip to main content
GET
/
public-api
/
agents
/
{agent_id}
Get an agent
curl --request GET \
  --url https://api.neoagent.io/public-api/agents/{agent_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.neoagent.io/public-api/agents/{agent_id}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.neoagent.io/public-api/agents/{agent_id}', 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.neoagent.io/public-api/agents/{agent_id}",
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: Bearer <token>"
],
]);

$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.neoagent.io/public-api/agents/{agent_id}"

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

req.Header.Add("Authorization", "Bearer <token>")

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.neoagent.io/public-api/agents/{agent_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.neoagent.io/public-api/agents/{agent_id}")

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

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

response = http.request(request)
puts response.read_body
{
  "data": {
    "actions": [
      {}
    ],
    "agent_settings": {},
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "integrations": {
      "ad": {
        "permissions": [
          {
            "require_til": false
          }
        ]
      },
      "autotask": {
        "permissions": [
          {
            "allow_delete": false,
            "allow_merge": true,
            "client_facing_settings": {
              "allow_notify_additional_contacts": false,
              "include_random_delay": false,
              "max_delay_minutes": 20,
              "min_delay_minutes": 10,
              "note_publish_id": "<string>",
              "note_type_id": "<string>",
              "notification_mode": "TICKET_NOTE",
              "skip_notifications_for_closed_tickets": true,
              "udf_field_name": "Notify Contact by Email",
              "use_custom_note_type": false,
              "use_udf_field": false
            },
            "require_til": false,
            "time_entry_udf_settings": {
              "include_dynamic_delay": false,
              "max_delay_minutes": 20,
              "min_delay_minutes": 10,
              "udf_field_name": "Notify Contact by Email",
              "use_udf_field": false
            },
            "update_allowed_fields": [
              "<string>"
            ]
          }
        ]
      },
      "confluence": {
        "permissions": [
          {
            "require_til": false
          }
        ]
      },
      "cw_asio": {
        "permissions": [
          {
            "require_til": false
          }
        ]
      },
      "cw_automate": {
        "permissions": [
          {
            "allow_delete": false,
            "require_til": false
          }
        ]
      },
      "cw_psa": {
        "permissions": [
          {
            "allow_bundle": true,
            "allow_delete": false,
            "allow_merge": true,
            "client_facing_settings": {
              "allow_notify_additional_contacts": false,
              "include_random_delay": false,
              "max_delay_minutes": 20,
              "min_delay_minutes": 10,
              "skip_notifications_for_closed_tickets": true
            },
            "require_til": false,
            "update_allowed_fields": [
              "<string>"
            ]
          }
        ]
      },
      "datto_rmm": {
        "permissions": [
          {
            "allow_delete": false,
            "require_til": false
          }
        ]
      },
      "exchange": {
        "permissions": [
          {
            "require_til": false
          }
        ]
      },
      "halo_psa": {
        "permissions": [
          {
            "allow_delete": false,
            "allow_merge": true,
            "allowed_outcome_ids": [
              "<string>"
            ],
            "client_facing_settings": {
              "allow_notify_additional_contacts": false,
              "allowed_outcome_ids": [
                "<string>"
              ],
              "include_random_delay": false,
              "max_delay_minutes": 20,
              "min_delay_minutes": 10,
              "skip_notifications_for_closed_tickets": true
            },
            "require_til": false,
            "update_allowed_fields": [
              "<string>"
            ]
          }
        ]
      },
      "hudu": {
        "permissions": [
          {
            "allow_delete": false,
            "require_til": false
          }
        ]
      },
      "itglue": {
        "permissions": [
          {
            "allow_delete": false,
            "require_til": false
          }
        ]
      },
      "ms_graph": {
        "permissions": [
          {
            "require_til": false
          }
        ]
      },
      "ncentral_rmm": {
        "permissions": [
          {
            "allow_delete": false,
            "require_til": false
          }
        ]
      },
      "neo_api": {
        "permissions": [
          {
            "require_til": false
          }
        ]
      },
      "ninja_rmm": {
        "permissions": [
          {
            "allow_delete": false,
            "require_til": false
          }
        ]
      },
      "nsight_rmm": {
        "permissions": [
          {
            "require_til": false
          }
        ]
      },
      "scalepad": {
        "permissions": [
          {
            "allow_delete": false,
            "require_til": false
          }
        ]
      },
      "screenconnect_rmm": {
        "permissions": [
          {
            "require_til": false
          }
        ]
      },
      "servicenow": {
        "permissions": [
          {
            "allow_delete": false,
            "require_til": false
          }
        ]
      },
      "vsax_rmm": {
        "permissions": [
          {
            "allow_delete": false,
            "require_til": false
          }
        ]
      }
    },
    "name": "<string>",
    "toolbox": {},
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timings_ms": {},
    "pagination": {
      "has_more": true,
      "next_cursor": "<string>"
    },
    "warnings": [
      "<string>"
    ]
  }
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}

Authorizations

Authorization
string
header
required

Authorization: Bearer <token> where <token> is either a neo_sk_<env>_<secret> API key (service account) or a Microsoft Entra ID access token (dashboard user).

Path Parameters

agent_id
string
required

Response

Success.

data
AgentDetail · object
required
meta
object
required