Skip to main content
POST
List entities with filters

Headers

x-project-id
string
required

Project ID to specify the project context

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
page
integer
default:1
Required range: x >= 1

Body

application/json
name
string

Filter entities by name using a case-insensitive partial match.

Example:

"Acme"

type
string

Filter entities by their exact type.

Example:

"brand"

isOwned
boolean

Filter entities by whether they are owned by the current project.

Example:

true

isPrimary
boolean

Filter entities by whether they are marked as primary.

Example:

true

isCompetitor
boolean

Filter entities by whether they are flagged as competitors.

Example:

false

isBlacklisted
boolean

Filter entities by whether they are blacklisted.

Example:

false

isRecurring
boolean

Filter entities by whether they have been seen in more than one AI response. Pass true to hide one-off extractions.

Example:

true

groupId
string

Filter entities attached to a specific container (group or division), by its ID. Exact-node: a group ID does not include entities in its divisions — use rootGroupId for that.

Example:

"018f3a2b-7c4d-7e91-b3f5-2a6c8d0e1f42"

rootGroupId
string

Filter entities under a top-level group, INCLUDING entities in its divisions.

Example:

"018f3a2b-7c4d-7e91-b3f5-2a6c8d0e1f42"

sort
object[]

Sort criteria for the entity list. Each item targets a sortable field (name, isPrimary, isOwned, isCompetitor, isBlacklisted, createdAt, updatedAt) with an ASC or DESC direction. Defaults to sorting by name ascending.

Example:

Response

page
object
required
results
object[]