Skip to main content
POST
List entity groups

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"

kind
enum<string>

Filter by container kind: "group" for top-level groups, "division" for divisions. Omit to list both.

Available options:
group,
division
parentId
string

Filter to the divisions of a given group, by group ID.

Example:

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

sort
object[]

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

Example:

Response

page
object
required
results
object[]