groups

List groups

Changed on

Retrieve all groups for the authenticated user. Groups are collections of contacts used to organize your network (e.g., "Coworkers", "College Friends").

get/v1/groups/

Request

  • Base URL: https://api.prod.getdex.com
  • URL: https://api.prod.getdex.com/v1/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

errorboolean required

Changes

  • 1e8a06015eafRevision changes
    • info

      added the enum value archived_at to the property /propertyNames/ of the query request parameter select

  • a2f71a243839Revision changes
    • info

      api operation id listGroupsV1 was added

    • info

      added the non-success response with the status