Skip to content

Get one agent

GET
/v1/agents/{id}
id
required
string
>= 1 characters <= 128 characters

The agent

object
id
required
string
external_id
required
string
name
required
string | null
framework
required
string | null
version
required
string | null
key_thumbprint
required
string | null
owner_id
required
string | null
label
required
string | null
notes
required
string | null
status
required
string
Allowed values: active paused_reporting
first_seen_at
required
string format: date-time
Example
2026-10-17T09:14:03.218Z
last_seen_at
required
string format: date-time
Example
2026-10-17T09:14:03.218Z
payment_count_30d
required
integer
spend_usd_minor_30d
required
string
rails
required
Array<string>

The request is not valid

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

Not signed in, or the API key is not valid

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

Not allowed for this role or key

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

Not found in your organization

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W