---
title: "List Entities"
method: GET
path: "/api/v1/entities"
tags: ["entities"]
---

# List Entities

`GET /api/v1/entities`

## Request

- Base URL: `https://api.gnosari.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gnosari.com/api/v1/entities`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-AUTH-TOKEN`

List extracted entities with filtering and pagination.
Returns entities and total count for pagination; when include_facets is
true, also returns filter-aware per-type and per-status facet counts.

## Query parameters

- `agent_id` integer, nullable: Filter by agent ID
- `entity_type_id` integer, nullable: Filter by entity type ID
- `status` 'NEW' | 'REVIEWED' | 'ACTIONED' | 'ARCHIVED': Status of an extracted entity in the workflow.
- `min_confidence` number, nullable: Minimum confidence score
- `max_confidence` number, nullable: Maximum confidence score
- `date_from` string, date-time, nullable: Filter from date
- `date_to` string, date-time, nullable: Filter to date
- `search` string, nullable: Search in attributes, agent name, or data type name
- `include_archived` boolean: Include archived entities
- `include_facets` boolean: Include filter-aware per-type and per-status facet counts
- `skip` integer: Number of items to skip
- `limit` integer: Maximum items to return

## Response `200`

Successful Response

- PaginatedExtractedEntitiesResponse: Paginated extracted entities from extracted_entity_service.
  - `data` ExtractedEntityRead[], required
    - `id` integer, required
    - `entity_type_id` integer, required
    - `agent_id` integer, required
    - `session_id` string, nullable, required
    - `attributes` object, required
    - `confidence_score` number, nullable, required
    - `status` 'NEW' | 'REVIEWED' | 'ACTIONED' | 'ARCHIVED', required: Status of an extracted entity in the workflow.
    - `is_manual` boolean, required
    - `notes` string, nullable, required
    - `account_id` integer, required
    - `entity_type_name` string, nullable
    - `entity_type_icon` string, nullable
    - `agent_name` string, nullable
    - `session_channel` string, nullable
    - `display_name` string, nullable
    - `contact_email` string, nullable
    - `contact_phone` string, nullable
    - `display_summary` string, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `pagination` PaginationInfo, required: Shared pagination metadata returned by all list endpoints.
    - `total` integer, required
    - `skip` integer, required
    - `limit` integer, required
    - `has_more` boolean, required
  - `facets` EntityFacets: Filter-aware facet counts for the entities list. ``entity_types`` are the per-template counts (nonzero groups only, ordered count desc, reusing ``TypeCountItem``); ``statuses`` maps each ``EntityStatus`` value to its count. Each facet ignores its OWN dimension's filter and applies all the others.
    - `entity_types` TypeCountItem[]
      - `template_id` integer, required
      - `template_name` string, required
      - `count` integer, required
    - `statuses` object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/gnosari/apis/gnosari-api.md) · [All operations](https://skmtc.dev/gnosari/apis/gnosari-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gnosari/apis/gnosari-api/revisions/f299cf53ae5f?raw)
