List Groups
Lists the available groups.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
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, otherwise if not set, then "after" is
used.
Allowed values:
name
Filters the groups on the basis of group name.
sort_by
Comma-separated fields to sort the groups by.
sync_metadata.external_reference
Filters for issues with this specific external reference.
sync_metadata.last_sync_in.status
Filters for works with selected sync statuses.
Allowed values:
sync_metadata.last_sync_in.sync_history
Filters for works modified with selected sync history.
sync_metadata.last_sync_in.sync_unit
Filters for works modified with selected sync units.
sync_metadata.last_sync_out.status
Filters for works with selected sync statuses.
Allowed values:
sync_metadata.last_sync_out.sync_history
Filters for works modified with selected sync history.
sync_metadata.last_sync_out.sync_unit
Filters for works modified with selected sync units.
sync_metadata.origin_system
Filters for issues synced from this specific origin system.
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.