Skip to main content
GET
/
api
/
v1
/
groups
/
{group_id}
/
members
List Group Members
curl --request GET \
  --url https://api.athenahq.ai/api/v1/groups/{group_id}/members \
  --header 'x-api-key: <api-key>'
{
  "members": [
    {
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "role": "<string>",
      "access_type": "organization",
      "created_at": "2023-11-07T05:31:56Z",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.athenahq.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

Successful response with the list of members

​
members
object[]
required