Retrieve Alerts

get

https://example.com/alerts

Returns a list of Alerts applicable to the scope of the API auth token

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

case

integer

Filter by case ID. Must supply integer value.

entry_agent

integer

Filter by the ID of the agent who created the alert.

mod_agent

integer

Filter by the ID of the agent associated with the alert.

send_email

boolean

Filter by send_email status. Returns alerts matching the supplied boolean value.

description

string

Filter via description. Wildcards supported. e.g. description=B% will return all records beginning with 'B'. Do not use quotations like description="B%".

last_email_sent

date

Filter by the date the last email was sent. Format: YYYY-MM-DD.

last_email_status

string

Filter by last email status value.

last_email_recipient_id

integer

Filter by the ID of the last email recipient agent.

order_by

string

Order results by a specified field. Prepend - for descending order. e.g. order_by=-id.

entry_date_before

string

Return records with an entry date before the supplied date. Format: YYYY-MM-DD.

entry_date_after

string

Return records with an entry date after the supplied date. Format: YYYY-MM-DD.

mod_date_before

string

Return records with a modification date before the supplied date. Format: YYYY-MM-DD.

mod_date_after

string

Return records with a modification date after the supplied date. Format: YYYY-MM-DD.

entry_date_gte

string

Return records with an entry date greater than or equal to the supplied date. Format: YYYY-MM-DD.

entry_date_lte

string

Return records with an entry date less than or equal to the supplied date. Format: YYYY-MM-DD.

mod_date_gte

string

Return records with a modification date greater than or equal to the supplied date. Format: YYYY-MM-DD.

mod_date_lte

string

Return records with a modification date less than or equal to the supplied date. Format: YYYY-MM-DD.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200search results matching criteria