Skip to main content
POST
/
api
/
entity-groups
/
list
List entity groups
curl --request POST \
  --url https://api.mentionlab.io/api/entity-groups/list \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "name": "Competitors",
  "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>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

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 entity groups by name using a case-insensitive partial match.

Example:

"Competitors"

sort
object[]

Sorting criteria for the returned entity groups. Supports sorting by "name" and "createdAt". Defaults to sorting by name in ascending order.

Example:
[{ "field": "name", "direction": "ASC" }]

Response

page
object
required
results
object[]