Get application notifications

Returns application notifications for the current user. These are notifications that detail updates for certain actions the user has taken, such as confirmation of successful profile updates, uploading of custom event videos from request, ect,...

Request

Query Params

type

enum<string>

optional

Type of notifications to return in the response. If not included, all notifications are instead returned.

Allowed values:

glacieralertdriveridsdformatcustclipupl_driversfail_upl_driverscard_unknown_driver

Body Params multipart/form-data

object {0}

Responses

🟢200valid get users notifications

application/json

Body

meta

object

required

code

integer

required

response

array [object {7}]

required

createtime

string <date-time>

required

Time notification was generated

Example:

Fri, 30 Aug 2024 14:56:47 GMT

geotab_user_id

string | null

required

Geotab user ID for Geotab integrated companies, otherwise returns null

integer

required

Notification ID

>= 0

notification

string

required

Description of notification. May contain an tag with href value to linked resource.

status

enum<string>

required

Status if notification has been viewed by user

Allowed values:

viewednot_viewed

type

enum<string>

required

Notification type

Allowed values:

glacieralertdriveridsdformatcustclipupl_driversfail_upl_driverscard_unknown_driver

user_id

integer

required

User ID for which the notification is associated with.

result

enum<string>

required

Allowed values:

OKFailed

Example

{
  "meta": {
    "code": 200
  },
  "response": [
    {
      "createtime": "Fri, 30 Aug 2024 14:56:47 GMT",
      "geotab_user_id": null,
      "id": 220207,
      "notification": "Custom video request for vehicle Truck 1 is now available. Event ID: <a href=/patterns/events/2602389/regular>2602389</a>",
      "status": "viewed",
      "type": "custclip",
      "user_id": 4737
    },
    {
      "createtime": "Thu, 25 Jul 2024 20:15:59 GMT",
      "geotab_user_id": null,
      "id": 220032,
      "notification": "Additional video request for vehicle Truck 42 is now available. Event ID: <a href=/patterns/events/2602083/regular>2602083</a>",
      "status": "viewed",
      "type": "alert",
      "user_id": 4737
    }
  ],
  "result": "OK"
}

🟠400get users notifications with invalid type

🟠401Login Required

Request

Request samples

Responses