Skip to main content
POST
/
api
/
entities
/
list
List entities with filters
curl --request POST \
  --url https://api.mentionlab.io/api/entities/list \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "name": "Acme",
  "type": "brand",
  "isOwned": true,
  "isPrimary": true,
  "isCompetitor": false,
  "isBlacklisted": false,
  "groupId": "9f8b1c2d-3e4f-5a6b-7c8d-9e0f1a2b3c4d",
  "sort": [
    {
      "field": "name",
      "direction": "ASC"
    }
  ]
}
'
{
  "page": {
    "totalRecords": 123,
    "limit": 123,
    "currentPage": 123,
    "totalPages": 123,
    "nextPage": 123,
    "prevPage": 123
  },
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "slug": "<string>",
      "isOwned": true,
      "isPrimary": true,
      "isCompetitor": true,
      "isBlacklisted": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "group": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "slug": "<string>"
      },
      "canonicalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

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

​
groupId
string

Filter entities belonging to a specific group, by group ID.

Example:

"9f8b1c2d-3e4f-5a6b-7c8d-9e0f1a2b3c4d"

​
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:
[{ "field": "name", "direction": "ASC" }]

Response

​
page
object
required
​
results
object[]