groups

List groups (v2)

Changed on

List all of the authenticated user's groups. Returns the canonical list envelope: { data: { groups: [...] } }. Supports ?orderBy[name]=asc|desc and ?orderBy[number_of_contacts]=asc|desc, plus ?where[has_parent]=true / ?where[has_subgroups]=true for sidebar tree navigation.

get/v2/groups/

Request

  • Base URL: https://api.prod.getdex.com
  • URL: https://api.prod.getdex.com/v2/groups/
  • Auth: HTTP bearer

Query parameters

nameunknown
number_of_contactsunknown
has_subgroupsboolean
has_parentboolean
has_namestring
not_instring[]
archivedboolean
parent_groupboolean
sub_groupsboolean
sub_groups_name_orderunknown
contacts_countboolean
sub_groups_countboolean
is_favoriteboolean
parent_groupboolean
sub_groupsboolean
sub_groups_name_orderunknown
contacts_countboolean
sub_groups_countboolean
is_favoriteboolean
idboolean
user_idboolean
nameboolean
emojiboolean
descriptionboolean
created_atboolean
parent_idboolean
rankingboolean
workspace_idboolean
archived_atboolean
parent_groupsboolean
groups_contactsboolean
viewsboolean
favoritesboolean
share_linksboolean
_countboolean
takeinteger
cursorstring uuid

Response

Successful response

Changes