Sign in

v50

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-0342108400.9 KB
Memberships

List memberships

List memberships of the current user.

get/v0.1/memberships

Query parameters

offsetinteger

Offset of the first member to return.

limitinteger
Example:10

Maximum number of members to return.

kindstring

The type of the membership resource. Possible values are:

  • merchant - merchant account(s)
  • organization - organization(s)
Example:merchant

Filter memberships by resource kind.

status'accepted' | 'pending' | 'expired' | 'disabled' | 'unknown'

The status of the membership.

Filter the returned memberships by the membership status.

resource.typestring

The type of the membership resource. Possible values are:

  • merchant - merchant account(s)
  • organization - organization(s)
Example:merchant

Filter memberships by resource kind.

resource.attributes.sandboxboolean

Filter memberships by the sandbox status of the resource the membership is in.

resource.namestring

Filter memberships by the name of the resource the membership is in.

resource.parent.idstring nullable

Filter memberships by the parent of the resource the membership is in. When filtering by parent both resource.parent.id and resource.parent.type must be present. Pass explicit null to filter for resources without a parent.

resource.parent.typestring

The type of the membership resource. Possible values are:

  • merchant - merchant account(s)
  • organization - organization(s)
Example:merchant

Filter memberships by the parent of the resource the membership is in. When filtering by parent both resource.parent.id and resource.parent.type must be present. Pass explicit null to filter for resources without a parent.

rolesstring[]

Filter the returned memberships by role.

[
  "role_employee",
  "role_accountant"
]

Response

Returns a list of Membership objects.

total_countinteger required

Example response

{
  "items": [
    {
      "id": "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
      "resource_id": "M2DDT39A",
      "type": "merchant",
      "roles": [
        "role_admin"
      ],
      "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-01-20T15:16:17Z",
      "invite": {
        "email": "boaty.mcboatface@sumup.com",
        "expires_at": "2023-01-20T15:16:17Z"
      },
      "metadata": {},
      "attributes": {},
      "resource": {
        "id": "M2DDT39A",
        "type": "merchant",
        "name": "Acme Corp",
        "logo": "https://images.sumup.com/img_2x4y6z8a0b1c2d3e4f5g6h7j8k.png",
        "created_at": "2023-01-20T15:16:17Z",
        "updated_at": "2023-01-20T15:16:17Z",
        "attributes": {}
      }
    }
  ],
  "total_count": 3
}