> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search for entities matching a query pattern.

> Query Parameters - q: Search query (supports regex patterns) - limit: Maximum number of results (default: 10) Response Returns a list of entities matching the…

**Query Parameters**

* `q`: Search query (supports regex patterns)
* `limit`: Maximum number of results (default: 10)
  **Response**
  Returns a list of entities matching the search criteria.
  Search entities by name/regex.

**Required scope:** `read`

### Query parameters

<ParamField query="q" type="string" required>
  Search query (supports regex patterns)
</ParamField>

<ParamField query="limit" type="integer">
  Maximum results (default 10, capped at max\_page\_size)
</ParamField>

### Response

`EntityResponse[]` — each element:

<ResponseField name="confidence" type="number (float)" required>
  Confidence score
</ResponseField>

<ResponseField name="created_at" type="string">
  Creation timestamp (RFC3339)
</ResponseField>

<ResponseField name="entity_type" type="string" required>
  Entity type
</ResponseField>

<ResponseField name="has_embedding" type="boolean" required>
  Whether entity has an embedding vector
</ResponseField>

<ResponseField name="id" type="string" required>
  Unique entity ID
</ResponseField>

<ResponseField name="name" type="string" required>
  Entity name
</ResponseField>

<ResponseField name="properties" type="object" required>
  Entity properties
</ResponseField>

<ResponseField name="updated_at" type="string">
  Last update timestamp (RFC3339)
</ResponseField>

### Status codes

| Code  | Meaning                                            |
| ----- | -------------------------------------------------- |
| `200` | Entities matching the search                       |
| `401` | Unauthorized — missing or invalid credentials      |
| `403` | Forbidden — the key/token lacks the required scope |
| `429` | Rate limited — see Retry-After / X-RateLimit-Reset |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.nsr.stateset.com/api/v1/entities/search' \
    --header 'X-API-Key: YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "confidence": 7.5,
      "created_at": "2026-08-31T14:22:05Z",
      "entity_type": "string",
      "has_embedding": true,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Two-Person Tent",
      "properties": {},
      "updated_at": "2026-08-31T14:22:05Z"
    }
  ]
  ```
</ResponseExample>