List entity relationships

GET

/v3/entities/{entityId}/relationships

curl --request GET \
  --url 'https://api.hopper.west.prod.govcloud.legion.picogrid.com/v3/entities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/relationships?created_after=2024-01-01T00%3A00%3A00Z&created_before=2024-12-31T23%3A59%3A59Z&limit=50&offset=0&type=DERIVED_FROM'

• US Government Production API
• Commercial Production API

Lists relationships whose source is the URL-path entity. Supports optional filters by relationship type and a created_at time range (created_after, created_before), plus limit/offset pagination.

Parameters

Path Parameters

entityId

required

string format: uuid

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

Responses

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

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

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

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

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

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