Skip to main content
GET
List Agents

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer | null
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

offset
integer | null
default:0

Number of items to skip

Required range: x >= 0
Example:

0

name
string | null

Agent Name

namePrefix
string | null

When set, only agents whose name starts with this string (case-sensitive). Ignored when name is also provided.

type
enum<string> | null

Filter by latest manifest discriminator (remote-agent, truefoundry-agent, or agent). NOTE: agent is a legacy type and will be removed in the future.

Available options:
remote-agent,
truefoundry-agent,
agent
attributes
string[] | null

Comma-separated list of attributes to return (e.g. id,name). When provided, only the specified fields are fetched. id is always included.

Response

Agents retrieved successfully

data
Agent · object[]
required

Array of Agents

pagination
Pagination · object
required

Pagination Information