List Alerts

Retrieve alerts for the authenticated user or company.

  • Default: Returns only alerts owned by the authenticated user

  • Company-wide: Users with external-api-get-all-company-alerts permission can view all authenticated user company alerts

Results are sorted by creation date (newest first). Returns an empty list with 200 OK if no alerts exist.

Endpoint

  • URL: https://api.genlogs.io/alerts

  • Method: GET

Authentication

Requires Bearer token with one of these permissions:

Permission
Access

external-api-get-alerts-endpoint

View own alerts

external-api-get-all-company-alerts

View all company alerts

Headers

Header
Type
Required
Description

Authorization

string

Yes

Bearer token

Request Example

Response (200 OK)

Response Fields

Field
Type
Description

id

integer

Unique alert identifier

disabled

boolean

Whether the alert is disabled

alert_name

string

Name of the alert

email

string

Email of the alert owner

cc_emails

array

List of CC email addresses for notifications

start_date

datetime

Alert start date (ISO 8601)

end_date

datetime

Alert end date (ISO 8601)

location_state

string

State filter for sightings

location_city

string

City filter for sightings

license_plate

string

License plate to search

license_plate_state

string

State of the license plate

usdot_number

string

USDOT number to search

mc_number

string

MC number to search

chassis_number

string

Chassis number to search

container_number

string

Container number to search

exact_match_chassis_number

boolean

Require exact match for chassis number

exact_match_container_number

boolean

Require exact match for container number

vin

string

VIN to search

cab_number

string

Cab number to search

trailer_logo

string

Trailer logo identifier

trailer_number

string

Trailer number to search

alert_type

string

Alert type: hot or normal

exact_match_trailer_number

boolean

Require exact match for trailer number

deep_search

string

Deep search query

exact_match_deep_search

boolean

Require exact match for deep search

notification_channels

array

Notification methods: EMAIL, WEBHOOK

create_date

datetime

Creation timestamp

Error Responses

chevron-rightPossible error responseshashtag
Status
Description

401

Unauthorized - Invalid or missing token

403

Forbidden - Missing required permission

500

Internal Server Error

Last updated