List Groups

Lists the available groups.

Headers

AuthorizationstringRequired

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

Query parameters

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, otherwise if not set, then "after" is used.
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_metadata.external_referencelist of stringsOptional
Filters for issues with this specific external reference.
sync_metadata.last_sync_in.statuslist of enumsOptional
Filters for works with selected sync statuses.
Allowed values:
sync_metadata.last_sync_in.sync_historylist of stringsOptional
Filters for works modified with selected sync history.
sync_metadata.last_sync_in.sync_unitlist of stringsOptional
Filters for works modified with selected sync units.
sync_metadata.last_sync_out.statuslist of enumsOptional
Filters for works with selected sync statuses.
Allowed values:
sync_metadata.last_sync_out.sync_historylist of stringsOptional
Filters for works modified with selected sync history.
sync_metadata.last_sync_out.sync_unitlist of stringsOptional
Filters for works modified with selected sync units.
sync_metadata.origin_systemlist of stringsOptional
Filters for issues synced from this specific origin system.

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