Sign in
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.

kind'merchant'

The kind of the membership resource. Possible values are:

  • merchant - merchant account(s)

Filter memberships by resource kind.

resource.attributes.sandboxboolean

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

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
}

Changes