List Group Members

Returns all users with access to a group. By default, the response merges organization members (implicit access to every group in the org) and users with explicit group-member rows, tagging each entry with an access_type field (organization or group). If a user has both an org membership and a group_members row, the merged view returns them once as access_type: "organization" (org precedence).

Use the access_type query parameter to filter: ?access_type=group returns the raw group_members rows (including users who also have org access), and ?access_type=organization returns only the org’s implicit members. Requires a global API key.

GET /api/v1/groups/{group_id}/members

List Group Members

cURL

curl --request GET \
  --url https://api.athenahq.ai/api/v1/groups/{group_id}/members \
  --header 'x-api-key: <api-key>'

200

Example

{
  "members": [
    {
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "[e-mail]",
      "role": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  ]
}

Authorizations

x-api-key · string · header · required

API key for authentication. You can create one here.

Path Parameters

group_id · string<uuid> · required

The unique identifier of the group

Query Parameters

access_type · enum<string>

Optional filter. Pass group to get only users explicitly added to this group's group_members table — a user who also has org access is still returned (raw rows, no dedup). Pass organization to get only the parent org's members. Omit the parameter to get the merged view with org-member precedence.

Available options: organization, group

Response

200

application/json

Successful response with the list of members

members · object[] · required

Show child attributes