API Reference
SupportAPI Feedback

Fetch All Alerts

get
https://{environment}/api/v4/alerts

Retrieves a list of all alerts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

Unique Identifier of the alert

string

Specify alertName of the alert

string

Specify type Id of the alert

string

Specify alertTypeName of the alert

string
enum

Specify mode of the alert (Default=0, Instant=1, Summary=2, Other=3)

Allowed:
boolean

Specifies whether alert is group based or vehicle based

boolean

Specifies whether alert is default alert or not

boolean

Specifies whether alert is Muted or not

boolean

Specifies whether alert is overridable

string

Specify the vehicleId to which alert belongs

string

Specify the vehicleName to which alert belongs

string

Specify the groupId to which alert belongs

string

Specify the groupName to which alert belongs

string
enum

Status of the record. Acceptable values are "Active", "Deleted", "Archived", "Draft" and are case sensitive.

Allowed:
uuid

The unique Azuga ID of the User who created the record.

uuid

The unique Azuga ID of the User who updated the record.

string
length ≥ 1

General search. where, Minimum length = 1.

string
enum

Specific column can be searched. Ideal way would be to pass searchValue.

Allowed:
string
enum

Specify sorting direction.

Allowed:
string
enum

Specific column to apply sorting on.

string
enum

Associations to include. For multiple associations, separate each with a comma.

Allowed:
integer

The maximum number of items to be returned in a single response. Use it in conjunction with the offset parameter to paginate results

integer

Specifies the starting position of the data set

Responses

Updated 6 months ago

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

Updated 6 months ago