Skip to content
Picogrid Legion

Search feed definitions

Search feed definitions

Open in ChatGPT ↗Open in Claude ↗
POST
/v3/feeds/definitions/search
curl --request POST \
  --url 'https://api.hopper.west.prod.govcloud.legion.picogrid.com/v3/feeds/definitions/search?limit=10&offset=0' \
  --header 'Content-Type: application/json' \
  --data '{ "category": "MESSAGE", "created_after": "2024-01-01T00:00:00Z", "created_before": "2024-12-31T23:59:59Z", "data_type": [ "application/json", "image/jpeg" ], "entity_id": "c3d4e5f6-a1b2-7890-1234-567890abcdef", "feed_name": "sensor_telemetry", "integration_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "is_active": true, "is_template": false, "organization_id": "550e8400-e29b-41d4-a716-446655440000", "template_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Search feed definitions with filtering and pagination

Parameters

Section titled “Parameters”

Query Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
category
string
Allowed values: MESSAGE FILE
Example
[
  "MESSAGE",
  "FILE"
]
created_after
string
Example
2024-01-01T00:00:00Z
created_before
string
Example
2024-12-31T23:59:59Z
data_type
string
Example
[
  "application/json",
  "image/jpeg"
]
entity_id
string format: uuid
Example
c3d4e5f6-a1b2-7890-1234-567890abcdef
feed_name
string
Example
sensor_telemetry
integration_id
string format: uuid
is_active
boolean
Example
true
is_template
boolean
Example
false
organization_id
string format: uuid
Example
550e8400-e29b-41d4-a716-446655440000
template_id
string format: uuid

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
category
required
string
Allowed values: MESSAGE FILE
created_at
required
string
data_type
required
string
description
string
entity_id
string format: uuid
feed_name
required
string
id
required
string format: uuid
integration_id
string format: uuid
is_active
required
boolean
is_template
required
boolean
metadata
object
organization_id
required
string format: uuid
schema_definition
object
template_id
string format: uuid
updated_at
required
string
total_count
required
integer
Example
{
  "paging": {
    "next": 2,
    "previous": null
  },
  "results": [
    {
      "category": "MESSAGE",
      "created_at": "2023-12-15T14:30:00Z",
      "data_type": "application/json",
      "description": "Real-time sensor telemetry data from field devices",
      "entity_id": "e5f6a1b2-c3d4-7890-1234-567890abcdef",
      "feed_name": "sensor_telemetry",
      "id": "d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a",
      "integration_id": "d4e5f6a1-b2c3-7890-1234-567890abcdef",
      "is_active": "true",
      "is_template": "false",
      "metadata": {
        "processing_pipeline": "temperature_normalization",
        "retention_policy": "30d",
        "source": "IoT Gateway",
        "update_frequency": "5s"
      },
      "organization_id": "550e8400-e29b-41d4-a716-446655440000",
      "schema_definition": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "properties": {
          "humidity": {
            "description": "Humidity percentage",
            "maximum": 100,
            "minimum": 0,
            "type": "number"
          },
          "temperature": {
            "description": "Temperature in Celsius",
            "maximum": 100,
            "minimum": -50,
            "type": "number"
          },
          "timestamp": {
            "description": "Measurement timestamp",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "temperature",
          "humidity",
          "timestamp"
        ],
        "type": "object"
      },
      "template_id": "f47ac10b-58cc-4372-a567-0e02b2c3d480",
      "updated_at": "2023-12-15T14:30:00Z"
    }
  ],
  "total_count": 18
}

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