Search for Playbook Alerts

Searches for Playbook Alerts based on filtering conditions supplied in the body. Not specifying a filter for a property means the filter will match a Playbook Alert regardless of the property's value. Only Playbook Alerts matching all specified criteria are included in the response.

What this endpoint does

The primary entry point for all Playbook Alerts workflows. Search with optional filters to retrieve alert summaries — the playbook_alert_id from each result is the key identifier for all downstream endpoints. After searching, call the category-specific bulk or detail endpoint for full evidence:

All filters are optional (AND logic). Valid filter values from Playbook Alerts: Metadata. Use offset (not the deprecated from) for pagination.

Response data

Returns alert summaries only — no evidence panels. Iterate response.data (an array, not response.data.results). Each object carries the playbook_alert_id, status, priority, category, title, timestamps, and assignee. Paginated via next_offset.

Body Params
integer
deprecated

Pagination offset, show items from this index and onwards. From + limit cannot exceed 10 000. This field cannot be used together with 'offset' field. This field is deprecated, use 'offset' and 'next_offset' fields to paginate search results instead.

integer

Pagination limit, show items up to this limit. From + limit cannot exceed 10 000.

string
enum

Order results by created or modified data.

Allowed:
string
enum

Order results ascending or descending.

Allowed:
entity
array of strings

Entity of the alert (ID). For Domain Abuse alerts the entity is the attacker domain and for Vulnerability Alerts the entity is the CVE.

entity
statuses
array of objects

Return Playbook Alerts with this status. Valid statuses can be listed in /metadata/common. If omitted or empty, all statuses will be selected.

statuses
Allowed:
priority
array of objects

Return Playbook Alerts with this priority. Valid priorities can be listed in /metadata/common. If omitted or empty, all priorities will be selected.

priority
Allowed:
category
array of objects

Return Playbook Alerts with this category. Valid categories can be listed in /metadata/common. If omitted or empty, all categories will be selected.

category
Allowed:
assignee
array of strings

Return Playbook Alerts with this assignee. Valid assignees can be listed in /metadata/assignees. If omitted or empty, no filtering will be done on assignee.

assignee
created_range
object

Time range

updated_range
object

Time range

organisation
array of strings

Return Playbook Alerts with either of the organisations as owner. If omitted or empty, no filtering will be done on organisations.

organisation
string

Allows pagination by using next_offset from previous search response. Cannot be used together with 'from' field.

Response

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