API ReferenceGroups

List Groups (POST)

Lists the available groups.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
created_bylist of stringsOptional
Filters the groups on the basis of creator.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
group_typelist of enumsOptional
Filters the groups based on the group type.
Allowed values:
ingestion_sourcelist of enumsOptional

Filter groups by ingestion source(s).

Allowed values:
is_defaultbooleanOptional
Whether to fetch default or custom groups.
limitintegerOptional
The maximum number of groups to return. The default is '50'.
member_typelist of enumsOptional
Filters the groups on basis of member type.
Allowed values:
modeenumOptional

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:
namelist of stringsOptional
Filters the groups on the basis of group name.
sort_bylist of stringsOptional

Comma-separated fields to sort the groups by.

sync_metadataobjectOptional

Response

The response to listing the groups.
groupslist of objects
The list of groups.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors