Members
List members
Lists merchant members.
get/v0.1/merchants/{merchant_code}/members
Path parameters
merchant_codestring required
Example:MK10CL2A
Short unique identifier for the merchant.
Query parameters
offsetinteger
Offset of the first member to return.
limitinteger
Example:10
Maximum number of members to return.
scrollboolean
Example:true
Indicates to skip count query.
emailstring
Example:user
Filter the returned members by email address prefix.
user.idstring uuid
Example:245b2ead-85bf-45ff-856f-311a88a5d454
Search for a member by user id.
status'accepted' | 'pending' | 'expired' | 'disabled' | 'unknown'
The status of the membership.
Filter the returned members by the membership status.
rolesstring[]
Filter the returned members by role.
[ "role_employee", "role_accountant" ]
Response
Returns a list of Member objects.
Example response
{
"items": [
{
"id": "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
"roles": [
"role_admin",
"role_owner"
],
"permissions": [
"members_read",
"members_write",
"create_moto_payments",
"full_transaction_history_view",
"refund_transactions",
"create_referral",
"developer_settings_edit",
"developer_settings_access"
],
"created_at": "2023-01-20T15:16:17Z",
"updated_at": "2023-02-20T15:16:17Z",
"user": {
"id": "44ca0f5b-813b-46e1-aee7-e6242010662e",
"email": "example@sumup.com",
"mfa_on_login_enabled": true,
"virtual_user": false,
"service_account_user": false
},
"status": "accepted"
}
],
"total_count": 3
}