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"
}
]
}Returns a paginated list of entities. Merged entities (those with a canonical reference) are excluded by default. Filter by name (partial match), type, classification flags (isOwned, isPrimary, isCompetitor, isBlacklisted), or group. Sortable by name, classification flags, createdAt, and updatedAt.
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"
}
]
}Project ID to specify the project context
Filter by name (partial match)
Filter by entity type
Filter by owned status
Filter by primary status
Filter by competitor status
Filter by blacklisted status
Filter by group ID
Show child attributes