Skip to content

Get all notifications for an organization

GET
/v3/notifications
curl --request GET \
--url 'https://api.hopper.west.prod.govcloud.legion.picogrid.com/v3/notifications?limit=10&offset=0'

Retrieves all notifications of an organization.

limit
integer
default: 10 >= 1 <= 50
Example
10
offset
integer
0
Example
0

Successful response

Media typeapplication/json
object
paging
required
object
next
required
integer | null
previous
required
integer | null
results
required
Array<object>
object
created_at
required
string
event
object
actor_id
string format: uuid
actor_type
string
Allowed values: USER ENTITY OTHER
created_at
required
string
event_description
string
event_timestamp
required
string
event_type
required
string
Allowed values: HUMAN VEHICLE VESSEL UAV FOOTSTEP ANIMAL GUNSHOT OTHER
id
required
string format: uuid
metadata
object
key
additional properties
any
organization_id
required
string format: uuid
source_id
required
string format: uuid
event_id
required
string format: uuid
event_timestamp
required
string
event_type
required
string
id
required
string format: uuid
metadata
object
key
additional properties
any
organization_id
required
string format: uuid
read_at
string
subscription_id
required
string format: uuid
total_count
required
integer
Example
{
"paging": {
"next": 2,
"previous": null
},
"results": [
{
"event": {
"actor_type": "USER",
"event_type": "HUMAN"
},
"event_timestamp": "2023-12-15T14:30:00Z",
"metadata": "2023-12-15T14:30:00Z"
}
],
"total_count": 8
}

Bad Request

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
"code": 400,
"details": [
{
"Field": "organization_id",
"Issue": "must be a valid UUID format"
}
],
"message": "Request cannot be processed due to invalid input",
"status": "error",
"timestamp": "2026-01-15T14:32:45Z",
"trace_id": "req_2J9K8L7M6N5P4Q3R"
}

Unauthorized

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
"code": 401,
"details": [
{
"Field": "authorization_header",
"Issue": "Bearer token is expired or malformed"
}
],
"message": "Authentication credentials are missing or invalid",
"status": "error",
"timestamp": "2026-01-15T14:32:45Z",
"trace_id": "req_2J9K8L7M6N5P4Q3R"
}

Forbidden

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
"code": 403,
"details": [
{
"Field": "required_scope",
"Issue": "requires 'orion:settings:write' scope, but token only has 'orion:settings:read'"
}
],
"message": "Access denied: insufficient permissions for this resource",
"status": "error",
"timestamp": "2026-01-15T14:32:45Z",
"trace_id": "req_2J9K8L7M6N5P4Q3R"
}

Not Found

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
"code": 404,
"details": [
{
"Field": "organization_id",
"Issue": "organization with ID 'a1b2c3d4-e5f6-7890-abcd-ef1234567890' not found"
}
],
"message": "The requested resource could not be found",
"status": "error",
"timestamp": "2026-01-15T14:32:45Z",
"trace_id": "req_2J9K8L7M6N5P4Q3R"
}

Internal Server Error

Media typeapplication/json
object
category
required

The category of the error

string
code
required

The HTTP status code

number
details

Additional details about the error

Array<object>
object
field

The field that caused the error

string
issue

The specific issue with the field

string
message
required

A human-readable error message

string
status
required

The status of the response, always ‘error’ for error responses

string
timestamp
required

The timestamp when the error occurred

string format: date-time
trace_id
required

A unique identifier for tracing the error

string format: uuid
Example
{
"category": "server_error",
"code": 500,
"details": [
{
"field": "field_name",
"issue": "Field validation issue"
}
],
"message": "Internal Server Error",
"status": "error",
"timestamp": "2024-03-15T10:30:00Z",
"trace_id": "b7c5e4d3-a2b1-4f0e-8d9c-1a2b3c4d5e6f"
}

Version 3.14.0 · commit 0771262