Skip to content
Picogrid Legion

Search event subscriptions

Search event subscriptions

Open in ChatGPT ↗Open in Claude ↗
POST
/v3/event-subscriptions/search
curl --request POST \
  --url 'https://api.hopper.west.prod.govcloud.legion.picogrid.com/v3/event-subscriptions/search?limit=10&offset=0' \
  --header 'Content-Type: application/json' \
  --data '{ "filters": { "alert_window": { "days": [], "end_time": "18:00", "start_time": "08:00", "timezone": "America/New_York" }, "delivery_frequency": "IMMEDIATE", "event_types": [ "HUMAN" ], "filters": { "actor_ids": [ "550e8400-e29b-41d4-a716-446655440000" ], "actor_type": "USER" }, "is_enabled": true, "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "organization_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sort": [ {}, {} ] }'

Search event subscriptions with complex filtering and pagination

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 10 >= 1 <= 1000
Example
10
offset
integer
0
Example
0

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
filters
object
alert_window
object
days
required
Array<integer>
Example
[]
end_time
required
string
Example
18:00
start_time
required
string
Example
08:00
timezone
required
string
Example
America/New_York
delivery_frequency
string
Allowed values: IMMEDIATE HOURLY DAILY WEEKLY
event_types
Array<string>
Allowed values: HUMAN VEHICLE VESSEL UAV FOOTSTEP ANIMAL GUNSHOT OTHER
filters
object
actor_ids
Array<string>
Example
[
  "550e8400-e29b-41d4-a716-446655440000"
]
actor_type
string
Allowed values: USER ENTITY OTHER
Example
USER
is_enabled
boolean
user_id
string format: uuid
organization_id
string format: uuid
sort
Array<object>
object
field
required
string
Allowed values: created_at updated_at is_enabled delivery_frequency
Example
created_at
order
required
string
Allowed values: asc desc
Example
desc
Example
[
  {},
  {}
]

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
paging
required
object
next
required
integer | null
previous
required
integer | null
results
required
Array<object>
object
alert_window
required
object
days
required
Array<integer>
end_time
required
string
start_time
required
string
timezone
required
string
created_at
required
string
delivery_frequency
required
string
Allowed values: IMMEDIATE HOURLY DAILY WEEKLY
event_types
required
Array<string>
Allowed values: HUMAN VEHICLE VESSEL UAV FOOTSTEP ANIMAL GUNSHOT OTHER
filters
object
actor_ids
Array<string>
actor_type
string
Allowed values: USER ENTITY OTHER
id
required
string format: uuid
is_enabled
required
boolean
last_triggered_at
string
min_interval
required
integer
organization_id
required
string format: uuid
updated_at
required
string
user_id
required
string format: uuid
total_count
required
integer
Example
{
  "paging": {
    "next": 2,
    "previous": null
  },
  "results": [
    {
      "alert_window": {
        "days": [],
        "end_time": "18:00",
        "start_time": "08:00",
        "timezone": "America/New_York"
      },
      "created_at": "2023-12-15T14:30:00Z",
      "delivery_frequency": "IMMEDIATE",
      "event_types": [
        "HUMAN"
      ],
      "filters": {
        "actor_ids": [
          "550e8400-e29b-41d4-a716-446655440000"
        ],
        "actor_type": "USER"
      },
      "last_triggered_at": "2023-12-15T14:30:00Z",
      "updated_at": "2023-12-15T14:30:00Z"
    }
  ],
  "total_count": 8
}

400

Section titled “400”

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"
}

401

Section titled “401”

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"
}

403

Section titled “403”

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"
}

404

Section titled “404”

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"
}

500

Section titled “500”

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