Skip to content
Picogrid Legion

Search entity relationships

Search entity relationships

Open in ChatGPT ↗Open in Claude ↗
POST
/v3/entities/relationships/search
curl --request POST \
  --url 'https://api.hopper.west.prod.govcloud.legion.picogrid.com/v3/entities/relationships/search?created_after=2024-01-01T00%3A00%3A00Z&created_before=2024-12-31T23%3A59%3A59Z&limit=50&offset=0&type=DERIVED_FROM' \
  --header 'Content-Type: application/json' \
  --data '{ "filters": { "target_entity_ids": [ "e5f6a1b2-c3d4-7890-1234-567890abcdef", "c3d4e5f6-a1b2-7890-1234-567890abcdef" ], "types": [ "DERIVED_FROM", "FUSED_FROM" ] }, "sort": [ {} ] }'

Reverse-lookup search by target entity IDs. Answers "which entities point at these targets?"

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
created_after
string
Example
2024-01-01T00:00:00Z
created_before
string
Example
2024-12-31T23:59:59Z
limit
integer
default: 50 >= 1 <= 1000
Example
50
offset
integer
0
Example
0
type
string
Example
DERIVED_FROM

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
filters
required
object
created_after
string
created_before
string
target_entity_ids
required
Array<string>
types
Array<string>
sort
Array<object>
object
field
required
string
order
required
string
Allowed values: asc desc
Example
{
  "filters": {
    "target_entity_ids": [
      "e5f6a1b2-c3d4-7890-1234-567890abcdef",
      "c3d4e5f6-a1b2-7890-1234-567890abcdef"
    ],
    "types": [
      "DERIVED_FROM",
      "FUSED_FROM"
    ]
  },
  "sort": [
    {}
  ]
}

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
created_at
required
string
deleted_at
string
id
required
string format: uuid
is_primary
required
boolean
properties
object
key
additional properties
any
source_entity_id
required
string format: uuid
target_entity_id
required
string format: uuid
type
required
string
updated_at
required
string
total_count
required
integer
Example
{
  "paging": {
    "next": 2,
    "previous": null
  },
  "results": [],
  "total_count": 3
}

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