---
title: "Search entities across documents"
method: GET
path: "/document_intelligence/entities/search"
tags: ["Analytics AI — Knowledge Graph"]
---

# Search entities across documents

`GET /document_intelligence/entities/search`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/document_intelligence/entities/search`
- Auth: HTTP bearer

Search for entities (companies, persons, IBANs, amounts, etc.) across all documents. Uses the entity index automatically built from your documents by the Document Intelligence pipeline.

## Query parameters

- `query` string, required
- `entity_type` 'company' | 'person' | 'iban' | 'amount' | 'reference' | 'address' | 'email' | 'phone' | 'date' | 'all'
- `limit` integer
- `type` string
- `workspace_id` integer, required

## Response `200`

Success

- object: Entity-Suche
  - `_billing` object
    - `credits` object
      - `total_monthly` integer
      - `remaining_monthly` integer
      - `credit_source` string
      - `api_handler` string
      - `tier_info` object
        - `tier` string
        - `name` string
        - `initial_credits` integer
        - `price_monthly` integer
        - `price_overage_per_credit` integer
      - `notice` string
      - `renewal_days` integer
      - `subscription_status` string
    - `job` object
      - `api_job_name` string
      - `app` string
      - `action` string
      - `option` string
      - `default_credits` integer
      - `credits_billed` integer
      - `pricing` object
        - `credits_per_unit` integer
        - `unit` string
        - `unit_count` integer
        - `addons` string
    - `requests` object
      - `limits` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `current` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `remaining` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `next_possible_request_seconds` integer
    - `remaining_credits` integer
    - `total_monthly` integer
    - `account_id` integer
    - `plan` object
      - `tier` string
      - `name` string
    - `credits_billed` integer
  - `canonical_row_note` string
  - `canonical_semantics` string
  - `document_count_scope` string
  - `entity_type_filter` string
  - `min_confidence` integer
  - `presentation` string
  - `processing_time` string
  - `query` string
  - `results` unknown[]
    - unknown
  - `status` string
  - `total` integer
  - `workspace_id` integer

## Other responses

- `4XX`: Error
- `5XX`: Error

---

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