---
title: List members
description: Lists active members in the workspace.
doc_version: 0.1.0-preview
last_updated: 2026-09-14
---

# List members

`GET /v1/workspaces/{workspaceId}/members`

Lists active members in the workspace. Requires the viewer role. Use query to filter by display name or email.

## Authentication

Send `Authorization: Bearer <GRAPHON_API_KEY>`. Read the key from the
GRAPHON_API_KEY environment variable. Never print it.

## Path parameters

- `workspaceId` (string) — The workspace id.

## Query parameters

- `query` (string (optional)) — Case-insensitive substring match on a member's display name or email. Omit to list every member.

## Example request

```bash
curl \
  --url "https://api.graphon.ai/v1/workspaces/wspq7ws2np5l8z4/members?query=ada" \
  --header "Authorization: Bearer $GRAPHON_API_KEY"
```

## CLI

```bash
graphon members list --query ada
```

## Example response

```json
{
  "items": [
    {
      "id": "memA1b2C3d4E5",
      "workspaceId": "wspq7ws2np5l8z4",
      "userId": "usrB2c3D4e5F6",
      "displayName": "Ada Lovelace",
      "email": "ada@example.com",
      "role": "admin",
      "status": "active",
      "joinedAt": "2026-09-14T18:00:00.000Z",
      "revision": 1
    }
  ]
}
```

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.