SaaS App and Device Management APIs | Developer APIs

limitinteger · min: 1 · max: 500Optional

The maximum number of agents to be returned in the response

Default: 500

pageTokenstringOptional

Cursor for getting the next page of results

querystringOptional

Prefix search across device name, device ID, and user email

itemsstring · enumOptionalPossible values:

itemsstring · enumOptionalPossible values:

agentVersionstring · enumOptional

Filter agents by version status

Possible values:

stealthModestring · enumOptional

Filter agents by stealth mode status

Possible values:

profileStatusstring · enumOptional

Filter agents by profile status

Possible values:

itemsstring · enumOptionalPossible values:

itemsstring · enumOptionalPossible values:

browserExtensionsstringOptional

Comma-delimited list of BROWSER:VALUE pairs to filter by browser extension status. VALUE may be either:

• a boolean (true/false) — true matches any installed/connected state, false matches not-installed; or
• a pipe-delimited list of installation states (e.g. EXTENSION_CONNECTED|EXTENSION_DISCONNECTED) to match agents whose extension is in any of the listed states. States may be passed in short form (EXTENSION_CONNECTED) or full form (BROWSER_EXTENSION_INSTALLATION_STATUS_EXTENSION_CONNECTED). Valid filter states: BROWSER_NOT_INSTALLED, BROWSER_INSTALLED, EXTENSION_INSTALLED, INSTALLATION_PENDING, EXTENSION_CONNECTED, EXTENSION_DISCONNECTED. Any other value (UNKNOWN, ERROR, or the unprefixed CONNECTED/DISCONNECTED forms) is silently dropped. Note: the response status field still echoes the bare proto enum names (e.g. BROWSER_EXTENSION_INSTALLATION_STATUS_CONNECTED) — only filter input uses the EXTENSION_ aliases. Supported browsers: BROWSER_CHROME, BROWSER_EDGE, BROWSER_FIREFOX, BROWSER_SAFARI, BROWSER_ARC, BROWSER_ATLAS, BROWSER_BRAVE, BROWSER_CHROME_BETA, BROWSER_COMET, BROWSER_VIVALDI.

Example: BROWSER_CHROME:EXTENSION_CONNECTED|EXTENSION_DISCONNECTED,BROWSER_EDGE:true