---
title: "List members"
method: GET
path: "/v0.1/merchants/{merchant_code}/members"
tags: ["Members"]
---

# List members

`GET /v0.1/merchants/{merchant_code}/members`

Lists merchant members.

## Path parameters

- `merchant_code` string, required

## Query parameters

- `offset` integer
- `limit` integer
- `scroll` boolean
- `email` string
- `user.id` string, uuid
- `status` 'accepted' | 'pending' | 'expired' | 'disabled' | 'unknown' — The status of the membership.
- `roles` string[]

## Response `200`

Returns a list of Member objects.

- object
  - `items` Member[], required
    - `id` string, required — ID of the member.
    - `roles` string[], required — User's roles.
    - `permissions` string[], required — User's permissions.
    - `created_at` string, date-time, required — The timestamp of when the member was created.
    - `updated_at` string, date-time, required — The timestamp of when the member was last updated.
    - `user` MembershipUser — Information about the user associated with the membership.
      - `id` string, required — Identifier for the End-User (also called Subject).
      - `type` 'user' | 'managed_user' | 'service_account' | 'system_account', required — Type of the user account.
      - `email` string, required — End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, for unique identification use ID instead.
      - `mfa_on_login_enabled` boolean, required — True if the user has enabled MFA on login.
      - `virtual_user` boolean, required — True if the user is a virtual user (operator).
      - `service_account_user` boolean, required — True if the user is a service account.
      - `disabled_at` string, date-time — Time when the user has been disabled. Applies only to virtual users (`virtual_user: true`).
      - `nickname` string — User's nickname. Used for display purposes only.
      - `picture` string, uri — URL of the End-User's profile picture. This URL refers to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image.
      - `classic` MembershipUserClassic — Classic identifiers of the user.
        - `user_id` integer, required
    - `invite` Invite — Pending invitation for membership.
      - `email` string, email, required — Email address of the invited user.
      - `expires_at` string, date-time, required
    - `status` 'accepted' | 'pending' | 'expired' | 'disabled' | 'unknown', required — The status of the membership.
    - `metadata` Metadata — Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. Maximum of 64 parameters are allowed in the object.
    - `attributes` Attributes — Object attributes that are modifiable only by SumUp applications.
  - `total_count` integer

## Other responses

- `404` — Merchant not found.

---

[API](https://skmtc.net/sumup/apis/sumup-rest-api.md) · [All operations](https://skmtc.net/sumup/apis/sumup-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumup/sumup-rest-api/versions/f50e1dc97523/schema)