List Groups (POST)
Lists the available groups.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
created_by
Filters the groups on the basis of creator.
cursor
The cursor to resume iteration from. If not provided, then
iteration starts from the beginning.
group_type
Filters the groups based on the group type.
Allowed values:
ingestion_source
Filter groups by ingestion source(s).
Allowed values:
is_default
Whether to fetch default or custom groups.
limit
The maximum number of groups to return. The default is '50'.
member_type
Filters the groups on basis of member type.
Allowed values:
mode
The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.
Allowed values:
name
Filters the groups on the basis of group name.
sort_by
Comma-separated fields to sort the groups by.
sync_metadata
Response
The response to listing the groups.
groups
The list of groups.
next_cursor
The cursor used to iterate subsequent results in accordance to the
sort order. If not set, then no later elements exist.
prev_cursor
The cursor used to iterate preceding results in accordance to the
sort order. If not set, then no prior elements exist.