Get entity

GET /data/entities/{instance_id}

Jwt authorization

Retrieve an entity by its ID and return it as a JSON object. Supports including relations. Requires project access.

Path parameters

instance_id string(uuid) Required

Query parameters

relations boolean

Whether to include relations

Responses

200 application/json

Entity retrieved successfully
Hide response attributes Show response attributes object
- id string(uuid)
- name string
- project_id string(uuid)
- entity_type_id string(uuid)
- status string
- data object
- type string
- created_at string(date-time)
- updated_at string(date-time)
400

Invalid ID format or query error

GET /data/entities/{instance_id}

curl \
 --request GET 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "SH010",
  "project_id": "b24a6ea4-ce75-4665-a070-57453082c25",
  "entity_type_id": "c24a6ea4-ce75-4665-a070-57453082c25",
  "status": "running",
  "data": {
    "frame_in": 1001,
    "frame_out": 1120
  },
  "type": "shot",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}