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": "<string>",
  "type": "<string>",
  "isOwned": true,
  "isPrimary": true,
  "isCompetitor": true,
  "isBlacklisted": true,
  "groupId": "<string>",
  "sort": [
    {
      "field": "<string>",
      "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>",
      "type": "brand",
      "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
number
Example:

50

page
number
Example:

1

Body

application/json
name
string

Filter by name (partial match)

type
string

Filter by entity type

isOwned
boolean

Filter by owned status

isPrimary
boolean

Filter by primary status

isCompetitor
boolean

Filter by competitor status

isBlacklisted
boolean

Filter by blacklisted status

groupId
string

Filter by group ID

sort
object[]

Response

200 - application/json
page
object
required
results
object[]