groups

Get a group (v2)

Changed on

Retrieve a single group by its unique ID. Returns the canonical envelope: { data: { group: {...} } }. Pass ?include[is_favorite]=true to inflate the response with a computed is_favorite boolean, or ?include[parent_group]=true / ?include[sub_groups]=true to hydrate the parent / children relations.

get/v2/groups/{groupId}

Request

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

Path parameters

groupIdstring uuid required

Query parameters

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

Response

Successful response

Changes