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

# Search Entities

`GET /v1/entities`

## Request

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

Entity picker: name search, member counts, merged husks excluded.

## Query parameters

- `q` string
- `limit` integer

## Response `200`

Successful Response

- EntitySearchResponse
  - `entities` EntitySearchItem[], required
    - `entity_id` integer, required
    - `canonical_name` string, required
    - `entity_type` string, required
    - `verified` boolean, required
    - `member_count` integer, required
  - `count` integer, required

## Other responses

- `422`: Validation Error

---

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