---
title: "List members"
method: GET
path: "/members"
tags: ["member"]
---

# List members

`GET /members`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/members`
- Auth: HTTP bearer

Members with their roles, shared items and end dates. A limited member sees only the owners.

## Response `200`

The result.

- object
  - `members` object[], required
    - `id` string, required
    - `user_id` string, required
    - `email` string, required
    - `name` string, required
    - `role` 'owner' | 'admin' | 'member' | 'limited' | 'viewer', required
    - `officer` boolean, required
    - `sees_pay` boolean, required
    - `access_ends_at` string, date-time, nullable, required
    - `shared_items` object[], required
      - `type` 'round' | 'envelope' | 'document' | 'room' | 'template', required
      - `id` string, required
    - `joined_at` string, date-time, required
  - `invitations` object[], required
    - `id` string, required
    - `email` string, required
    - `role` 'owner' | 'admin' | 'member' | 'limited' | 'viewer', required
    - `shared_items` object[], required
      - `type` 'round' | 'envelope' | 'document' | 'room' | 'template', required
      - `id` string, required
    - `access_ends_at` string, date-time, nullable, required
    - `expires_at` string, date-time, required

## Other responses

- `default`: An RFC 9457 problem.

---

[API](https://skmtc.dev/binderwork/apis/binderwork-api.md) · [All operations](https://skmtc.dev/binderwork/apis/binderwork-api/llms.txt) · [OpenAPI document](https://skmtc.dev/binderwork/apis/binderwork-api/revisions/f8fab0ebee53?raw)