groups

Get a group

Changed on

Retrieve a single group by its unique ID, including its name and metadata.

get/v1/groups/{groupId}

Request

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

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 getGroupV1 was added

    • info

      added the non-success response with the status