List Notifications
curl --request GET \
--url https://api.example.com/api/v1/customer/notifications \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/customer/notifications"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/customer/notifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/customer/notifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/customer/notifications"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/customer/notifications")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/customer/notifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"notificationRecipientId": "0197fa01-d2e2-70df-8fd3-9e22a345a196",
"notificationId": "0197fa00-3e63-7f58-a878-7ef7ecfa9bc1",
"recipientUserId": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
"status": "UNREAD",
"notification": {
"audience": "OPS",
"body": "O passageiro respondeu ao chamado.",
"notificationId": "0197fa00-3e63-7f58-a878-7ef7ecfa9bc1",
"priority": "NORMAL",
"status": "ACTIVE",
"title": "Nova mensagem no chamado",
"type": "SUPPORT_CASE_CREATED",
"organizationId": null,
"payload": {
"supportCaseCode": "SUP-20260710-0001"
},
"resource": "SUPPORT_CASE",
"resourceDomain": "SUPPORT",
"resourceId": null,
"expiresAt": null
},
"recipient": {
"name": "Maria Silva",
"userId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"phoneIso": "BR",
"phoneDdi": "55",
"phoneNumber": "99999999999",
"avatar": "users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
"email": "maria@example.com"
},
"createdAt": "2026-07-10T12:00:00.000Z",
"updatedAt": "2026-07-10T12:00:00.000Z",
"createdBy": null,
"updatedBy": null,
"deletedBy": null,
"deliveredAt": null,
"readAt": null,
"archivedAt": null,
"deletedAt": null
}
],
"meta": {
"limit": 10,
"page": 1,
"totalItems": 100,
"totalPages": 10
}
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Internal Server Error",
"statusCode": 500
}Notification
List Notifications
Lists inbox notifications.
GET
/
api
/
v1
/
customer
/
notifications
List Notifications
curl --request GET \
--url https://api.example.com/api/v1/customer/notifications \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/customer/notifications"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/customer/notifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/customer/notifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/customer/notifications"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/customer/notifications")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/customer/notifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"notificationRecipientId": "0197fa01-d2e2-70df-8fd3-9e22a345a196",
"notificationId": "0197fa00-3e63-7f58-a878-7ef7ecfa9bc1",
"recipientUserId": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
"status": "UNREAD",
"notification": {
"audience": "OPS",
"body": "O passageiro respondeu ao chamado.",
"notificationId": "0197fa00-3e63-7f58-a878-7ef7ecfa9bc1",
"priority": "NORMAL",
"status": "ACTIVE",
"title": "Nova mensagem no chamado",
"type": "SUPPORT_CASE_CREATED",
"organizationId": null,
"payload": {
"supportCaseCode": "SUP-20260710-0001"
},
"resource": "SUPPORT_CASE",
"resourceDomain": "SUPPORT",
"resourceId": null,
"expiresAt": null
},
"recipient": {
"name": "Maria Silva",
"userId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"phoneIso": "BR",
"phoneDdi": "55",
"phoneNumber": "99999999999",
"avatar": "users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
"email": "maria@example.com"
},
"createdAt": "2026-07-10T12:00:00.000Z",
"updatedAt": "2026-07-10T12:00:00.000Z",
"createdBy": null,
"updatedBy": null,
"deletedBy": null,
"deliveredAt": null,
"readAt": null,
"archivedAt": null,
"deletedAt": null
}
],
"meta": {
"limit": 10,
"page": 1,
"totalItems": 100,
"totalPages": 10
}
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Internal Server Error",
"statusCode": 500
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Items per page
Example:
10
Page number
Example:
1
Created at range
Example:
">=2024-01-01;<=2024-12-31"
Notification priority
Available options:
LOW, NORMAL, HIGH, URGENT Example:
"NORMAL"
Related resource
Example:
"SUPPORT_CASE"
Related resource domain
Example:
"SUPPORT"
Recipient status
Available options:
UNREAD, READ, ARCHIVED Example:
"UNREAD"
Notification type
Available options:
SUPPORT_CASE_CREATED, SUPPORT_CASE_MESSAGE_CREATED, SUPPORT_CASE_ASSIGNED, SUPPORT_CASE_STATUS_CHANGED, ROUTE_APPROVAL_REQUESTED, ROUTE_APPROVED, ROUTE_REJECTED, TRIP_STATUS_CHANGED, TRIP_EVENT_RECORDED, OPERATIONAL_GUARD_ALERT, PAYMENT_CONFIRMED, PAYMENT_FAILED, TRANSFER_PROCESSED, TRANSFER_FAILED, ORDER_CONFIRMED, ORDER_CANCELLED, TICKET_CANCELLED, BENEFIT_REQUEST_APPROVED, BENEFIT_REQUEST_REJECTED, EXPORT_COMPLETED, EXPORT_FAILED Example:
"SUPPORT_CASE_CREATED"
Field to sort by
Available options:
createdAt, readAt, priority Example:
"createdAt"
Sort order
Available options:
asc, desc Example:
"desc"
Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.