Retrieve Info About a Group

This page is no longer maintained (Mar 29, 2023). For the most current information, go to https://docs.snaplogic.com/public-apis/get-groups-org-group.html

 

GET /groups/{org}/{groupname}

Overview

This API retrieves information about the specified group.

Prerequisites

You need:

  • Org Admin permissions.

Request

Path Parameters

Key

Description

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

org

Required. The name of the SnapLogic Org.

groupname

Required. The name of the group.

Query Parameters

None.

Request Header

Specify Basic for authorization and application/json for content type.

Request Body

None.

Response

Response Body

{ "name": "...", "members": [ ... ] }

Key

Type

Description

Key

Type

Description

name

string

The name of the group.

members

array

An array of strings containing the usernames or email addresses of the group members.