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

# List members

`GET /members`

## Request

- Base URL: `https://shipmail.to/api/v1`
- URL: `https://shipmail.to/api/v1/members`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://shipmail.to/api/auth/oauth2/authorize`, token URL `https://shipmail.to/api/auth/oauth2/token`)

List person members with roles and mailbox access. Selected mailbox IDs are limited to the calling credential's effective mailbox reach and resource constraints and may be incomplete.

## Query parameters

- `cursor` string
- `limit` integer

## Headers

- `X-Shipmail-Organization` string

## Response `200`

Paginated list of members.

- object
  - `data` Member[], required
    - `object` 'member', required
    - `id` string, required: Plain member ID. Member IDs do not use a required prefix.
    - `email` string, email, required
    - `name` string, required
    - `role` 'owner' | 'admin' | 'member', required
    - `mailbox_access` object, required
      - `scope` 'all' | 'selected', required: The person's mailbox access, independent of their organization role.
      - `mailbox_ids` string[], required: Empty for all. For selected, includes only granted mailboxes visible within the calling credential's effective mailbox reach and resource constraints; this list may be incomplete. An empty selected list may mean no grants or no visible grants.
    - `created_at` string, date-time, required
  - `pagination` Pagination, required
    - `next_cursor` string, nullable, required: Cursor for the next page. Null if no more results.
    - `has_more` boolean, required: Whether more results exist beyond this page.
    - `limit` integer, required: Number of items per page.

## Other responses

- `422`: Validation failed.
- `429`: Rate limit exceeded.

---

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