Skip to main content
GET
/
notification
/
alert
Get all notifications
curl --request GET \
  --url https://ctechnology.io/api/v2.2/notification/alert \
  --header 'Authorization: <api-key>'
{
  "header": {
    "num_results": 123,
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "via": "me",
        "organization_id": "<string>"
      }
    ],
    "offset": 123,
    "limit": 123
  },
  "data": [
    {
      "id": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "type": "VEHICLE_MOV",
      "priority": "ALERT",
      "title": "<string>",
      "message": "<string>",
      "data": "<unknown>",
      "read": true,
      "vehicle_id": "<string>",
      "action_id": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Note that the API key has to be sent as Token 123 where 123 is the key you received after logging in or by creating on the developer dashboard.

Query Parameters

​
vehicle_id
string

Limit the returned values to notifications that concerned a single vehicle.

​
offset
number
default:0

Offset the returned values by a given number of items.

​
limit
number
default:50

Limit the returned values to a given number of items.

​
status
enum<string>

Limit the returned values to either read or unread notifications. If this parameter is not passed, both read and unread notifications are returned.

If a notification is read by a user or not.

Available options:
read,
unread
​
from
string<date-time>

Limit the returned values to notifications whose timestamp is after the indicated one. If this parameter is not given, all notifications until now are returned.

​
to
string<date-time>

Limit the returned values to notifications whose timestamp is before the indicated one.

Response

Successful retrieval the notifications as requested.

​
header
API Header Paginated · object
required

Default header sent along with multi-resource responses (lists of resources).

​
data
Notification · object[]
required

A list of notifications.