API Reference
  1. Entity Correlation API
  2. Actors

Get a List of Actors

get
https://example.com/public/v1/entities/actors

Retrieve a list of actors from your organization. Each actor includes its description, risk_level, linked users, and linked hosts.Use filters to narrow results, or search_text for keyword search across indexed actor text.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
length between 1 and 1024

Keyword search across the actor's indexed text (names, emails, host names, tags, description, and related fields).

length between 1 and 1024

Return actors linked to a user with this exact username.

length between 1 and 1024

Return actors linked to a user with this exact email address.

length between 1 and 1024

Return actors linked to a host with this exact host ID.

length between 1 and 1024

Return actors linked to a host with this exact display name.

length between 1 and 1024

Return actors linked to a host with this exact endpoint identifier from your security tools.

enum

Filter by actor risk level: high, low, or escalated.

array | null

Return actors that have any of these platform-managed tags.

array | null

Return actors whose combined user/host tags include any of these values.

array | null

Return actors whose combined user/host groups include any of these values.

When set, only return active actors (and apply the same filter to nested users and hosts in the response).

integer
≥ 0
Defaults to 0

Pagination offset (number of actors to skip).

integer
1 to 1000
Defaults to 100

Maximum number of actors to return (1–1000).

Headers
string
required

Your API Key ID

string

Your API Key Secret

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?