Skip to content
Prefactor Docs

List agents

GET
/api/v1/agent

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
idempotency_key
One of:

Optional idempotency key for ensuring request idempotency

string
risk_profile_id
One of:
RiskProfile_Id

A valid risk profile ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
sorting
string

Sort order; a field name, optionally prefixed with - for descending (e.g. -created_at).

pagination[offset]
integer

Zero-based offset of the first item to return.

pagination[page_size]
integer
>= 1 <= 100

Number of items to return per page (1-100).

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
pagination
One of:
PaginationOutput

Pagination information

object
item_count

The total number of items

integer
item_end

The index of the last item in the page (one-based)

integer
item_start

The index of the first item in the page (one-based)

integer
next_page_offset
One of:

The offset of the next page (null if last page)

integer
page_count

The total number of pages

integer
page_index

The index of the current page (one-based)

integer
page_offset

The offset of the first item in the page (zero-based)

integer
page_size

The number of items per page

integer
previous_page_offset
One of:

The offset of the previous page (null if first page)

integer
Example
{
  "item_count": 200,
  "item_end": 100,
  "item_start": 91,
  "next_page_offset": 110,
  "page_count": 20,
  "page_index": 10,
  "page_offset": 90,
  "page_size": 10,
  "previous_page_offset": 80
}
sorting
One of:
Sorting

Sorting information

object
direction

The direction to sort by

string
Allowed values: asc desc
Example
asc
field

The field to sort by (values depend on the type of list)

string
Allowed values: id last_seen status title timestamp started_at finished_at email name external_identifier
Example
id
status
string
Allowed values: success
Example
success
summaries
Array<object>
Agent_Summary
object
available_actions
Agent_AvailableActions

Available actions for this agent based on its status and instance counts

object
delete

Whether the agent can be deleted

boolean
reinstate

Whether the agent can be reinstated from retired

boolean
retire

Whether the agent can be retired

boolean
update

Whether the agent can be updated

boolean
description
One of:

Agent description

string
Example
Agent description
id
Agent_Id

A valid agent ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
inserted_at

When the agent was created

string format: date-time
Example
2024-01-01T00:00:00Z
name

Agent name

string
Example
My Agent
status

Agent status

string
Allowed values: pending active dormant retired
Example
pending
type

Type of resource (always ‘agent’)

string
Allowed values: agent
Example
agent
updated_at

When the agent was last updated

string format: date-time
Example
2024-01-01T00:00:00Z

default

Section titled “default ”

Error

One of:
object
code
string
Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_value required_value idempotency_key_already_used
Example
bad_request
message
string
status
string
Allowed values: error
Example
error