Get paginated entity locations by entity ID

GET

/v3/entities/{entityId}/locations

curl --request GET \
  --url https://us-gov.legion.picogrid.com/v3/entities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/locations

• US Government Production API
• Staging API
• Demo API

Retrieves all entity locations that belong to the specific entity ID.

Parameters

Path Parameters

entityId

required

string format: uuid

Query Parameters

offset

number

limit

number

Responses

200

Successful response

Media typeapplication/json

object

paging

required

object

next

number

previous

number

results

required

Array<object>

object

created_at

required

string

entity

object

affiliation

string

Allowed values: PENDING UNKNOWN ASSUMED_FRIEND FRIEND NEUTRAL SUSPECT HOSTILE EXERCISE_PENDING EXERCISE_UNKNOWN EXERCISE_FRIEND EXERCISE_NEUTRAL EXERCISE_ASSUMED_FRIEND JOKER FAKER NONE_SPECIFIED

category

string

created_at

string

deleted_at

string

id

string format: uuid

metadata

object

name

string

organization_id

string format: uuid

parent_id

string format: uuid

status

string

type

string

updated_at

string

entity_id

required

string format: uuid

id

required

string format: uuid

orientation

Array<number>

>= 4 items <= 4 items

position

required

object

coordinates

Array<number>

>= 3 items <= 3 items

type

string

/^Point$/

recorded_at

string

source

required

string

total_count

required

number

Example

{
  "paging": "sample_value",
  "results": [
    {
      "created_at": "2024-01-15T11:00:00Z",
      "entity": "sample_value",
      "entity_id": "c3d4e5f6-a1b2-7890-1234-567890abcdef",
      "id": "10c98fcd-e351-4a2d-7af1-29876543210a",
      "orientation": "sample_value",
      "position": "sample_value",
      "recorded_at": "2024-01-15T11:00:00Z"
    }
  ],
  "total_count": "15"
}

400

Bad Request

Media typeapplication/json

object

category

string

code

number

details

Array<object>

object

field

required

string

issue

required

string

message

string

status

string

timestamp

string

trace_id

string

Example

{
  "code": "400",
  "details": "sample_value",
  "message": "Request cannot be processed due to invalid input",
  "status": "error",
  "timestamp": "2025-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

401

Unauthorized

Media typeapplication/json

object

category

string

code

number

details

Array<object>

object

field

required

string

issue

required

string

message

string

status

string

timestamp

string

trace_id

string

Example

{
  "code": "401",
  "details": "sample_value",
  "message": "Authentication credentials are missing or invalid",
  "status": "error",
  "timestamp": "2025-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

403

Forbidden

Media typeapplication/json

object

category

string

code

number

details

Array<object>

object

field

required

string

issue

required

string

message

string

status

string

timestamp

string

trace_id

string

Example

{
  "code": "403",
  "details": "sample_value",
  "message": "Access denied: insufficient permissions for this resource",
  "status": "error",
  "timestamp": "2025-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

404

Not Found

Media typeapplication/json

object

category

string

code

number

details

Array<object>

object

field

required

string

issue

required

string

message

string

status

string

timestamp

string

trace_id

string

Example

{
  "code": "404",
  "details": "sample_value",
  "message": "The requested resource could not be found",
  "status": "error",
  "timestamp": "2025-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

required

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