Skip to main content
GET
List Agent Profiles

Authorizations

X-Asteroid-Agents-Api-Key
string
header
required

Query Parameters

organizationId
string<uuid>

Filter by organization ID

pageSize
integer<int32>
default:50
page
integer<int32>
default:1
searchName
string

Search profiles by name (partial match)

proxyMode
enum<string>[]

Filter by proxy mode (can specify multiple, there is an 'OR' condition applied to these)

Proxy configuration mode

Available options:
none,
managed,
custom,
gateway
operatingSystem
enum<string>[]

Filter by emulated operating system (can specify multiple, there is an 'OR' condition applied to these). Profiles without an explicit operating system count as macOS.

Operating system to emulate in the browser

Available options:
macos,
windows
feature
enum<string>[]

Filter by active browser features (can specify multiple, there is an 'AND' condition applied to these — every listed feature must be enabled)

Browser feature toggles on an agent profile that can be filtered on

Available options:
extraStealth,
allow3rdCookies,
captchaSolverActive,
stickyIP,
cachePersistence,
adblockActive,
popupBlockerActive,
forcePopupsAsTabsActive,
mediaBlockerActive
sortField
enum<string>

Available fields for sorting agent profiles

Available options:
name,
created_at,
updated_at
sortDirection
enum<string>
Available options:
asc,
desc

Response

The request has succeeded.

items
object[]
required
page
integer<int64>
required
pageSize
integer<int64>
required
total
integer<int64>
required