---
title: "List entities"
method: GET
path: "/brands/{brandId}/entities"
tags: ["entities"]
---

# List entities

`GET /brands/{brandId}/entities`

## Request

- Base URL: `https://shruwd.io/api/v1`
- URL: `https://shruwd.io/api/v1/brands/{brandId}/entities`
- Auth: HTTP bearer

The self entity first, then every competitor, each with its current aliases, domains, exclusions and context terms.

## Response `200`

Entities.

- object
  - `entities` Entity[], required
    - `entityId` string, required
    - `name` string, required
    - `isSelf` boolean, required: True for the brand itself.
    - `requiresContext` boolean, required: Mentions count only near one of `contextTerms`.
    - `needsContextTerms` boolean, required: The name or an alias is six characters or fewer or an ordinary English word, so the entity needs context terms to count only real mentions. True with `requiresContext` false means the entity is matching without them; set some with PUT /entities/{entityId}, or remove the alias.
    - `genericSpelling` string, nullable, required: The spelling, name or alias, that makes `needsContextTerms` true; null when none does.
    - `contextTerms` string[], required
    - `aliases` Alias[], required
      - `aliasId` string, required
      - `alias` string, required
      - `kind` 'name' | 'product' | 'abbreviation' | 'misspelling', required
      - `caseSensitive` boolean, required: True for acronyms: `SAP`, not `sap`.
    - `domains` string[], required
    - `exclusions` string[], required
    - `createdAt` string, date-time, required

## Other responses

- `404`: `not_found`: no such resource in this workspace.
- `default`: Every failure has this body.

---

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