List memberships

GET/v0.1/memberships

List memberships of the current user.

OAuth scopes: Requires one of: user.profile, user.profile_readonly.

Authorization

Use one of the following alternatives:

apiKey
oauth2 with scopes user.profileuser.profile_readonly

Authorization guide

Query parameters

offsetinteger
minimum: 0default: 0
Offset of the first member to return.

Example: 0
limitinteger
minimum: 1maximum: 25default: 10
Maximum number of members to return.

Example: 10
kindstring
Filter memberships by resource kind.

Example: "merchant"
statusstring
Options:"accepted""pending""expired""disabled""unknown"
Filter the returned memberships by the membership status.
typestring
Filter memberships by resource kind.

Example: "merchant"
sandboxboolean
Filter memberships by the sandbox status of the resource the membership is in.
namestring
Filter memberships by the name of the resource the membership is in.
idstring
Filter memberships by the ID of the resource the membership is in.
idstring
Filter memberships by the parent of the resource the membership is in. Omit both resource.parent.id and resource.parent.type to skip parent filtering. When filtering by parent, both parameters must be present. To select resources without a parent, set each parameter to an empty value. Otherwise, both parameters must identify a parent.
typestring
Filter memberships by the parent of the resource the membership is in. Omit both resource.parent.id and resource.parent.type to skip parent filtering. When filtering by parent, both parameters must be present. To select resources without a parent, set each parameter to an empty value. Otherwise, both parameters must identify a parent.

Example: "merchant"
rolesarray<string>
Filter the returned memberships by role.

Example: ["role_employee","role_accountant"]

Responses

200application/json

Returns a list of Membership objects.

itemsarray<object>required
Show 12 properties
- idstringrequired
  ID of the membership.
  
  Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
- resource_idstringrequired
  ID of the resource the membership is in.
  
  Example: "M2DDT39A"
- typestringrequired
  The type of the membership resource. Possible values are:
  
  merchant - merchant account(s)
  
  organization - organization(s)
  
  Example: "merchant"
- rolesarray<string>required
  User's roles.
  
  Example: ["role_admin"]
- permissionsarray<string>requireddeprecated
  User's permissions.
  
  Example: ["members_read","members_write","create_moto_payments","full_transaction_history_view","refund_transactions","create_referral","developer_settings_edit","developer_settings_access"]
- created_atstringrequired
  format: date-time
  The timestamp of when the membership was created.
  
  Example: "2023-01-20T15:16:17Z"
- updated_atstringrequired
  format: date-time
  The timestamp of when the membership was last updated.
  
  Example: "2023-01-20T15:16:17Z"
- statusstringrequired
  Options:"accepted""pending""expired""disabled""unknown"
  The status of the membership.
- resourceobjectrequired
  Information about the resource the membership is in.
  
  Show 7 properties
  idstringrequired
  ID of the resource the membership is in.
  
  Example: "M2DDT39A"
  typestringrequired
  The type of the membership resource. Possible values are:
  
  merchant - merchant account(s)
  
  organization - organization(s)
  
  Example: "merchant"
  namestringrequired
  Display name of the resource.
  
  Example: "Acme Corp"
  created_atstringrequired
  format: date-time
  The timestamp of when the membership resource was created.
  
  Example: "2023-01-20T15:16:17Z"
  updated_atstringrequired
  format: date-time
  The timestamp of when the membership resource was last updated.
  
  Example: "2023-01-20T15:16:17Z"
  logostring
  format: urimaxLength: 256
  Logo fo the resource.
  
  Example: "https://images.sumup.com/img_2x4y6z8a0b1c2d3e4f5g6h7j8k.png"
  attributesobject
  Object attributes that are modifiable only by SumUp applications.
  
  Example: {}
- inviteobject
  Pending invitation for membership.
  
  Show 2 properties
  emailstringrequired
  format: email
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
  expires_atstringrequired
  format: date-time
  Example: "2023-01-20T15:16:17Z"
- metadataobject
  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.
  
  Example: {}
- attributesobject
  Object attributes that are modifiable only by SumUp applications.
  
  Example: {}
total_countintegerrequired
Example: 3

400application/problem+json

Invalid query parameter combination.

typestringrequired
format: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestring
format: uri
A URI reference that identifies the specific occurrence of the problem.

401application/problem+json

Authentication failed or missing required scope.

typestringrequired
format: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestring
format: uri
A URI reference that identifies the specific occurrence of the problem.

GET

Code sample

curl --request GET \
  --url https://api.sumup.com/v0.1/memberships \
  --header 'Authorization: Bearer <token>'

import SumUp from "@sumup/sdk";

async function main() {
  const client = new SumUp({ apiKey: "sup_sk_your_api_key" });

  const result = await client.memberships.list(
    {
      "offset": 0
    }
  );
  console.log(result);
}

main().catch(console.error);

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using SumUp;

public static class Program
{
    public static async Task Main()
    {
        using var client = new SumUpClient();
        var response = await client.Memberships.ListAsync(
            new MembershipsListOptions
            {
                Offset = 10,
                Limit = 10,
                Kind = "example",
                Status = MembershipStatus.Accepted,
                ResourceType = "example",
                ResourceAttributesSandbox = true,
                ResourceName = "example",
                ResourceId = "example-id",
                ResourceParentId = "example-id",
                ResourceParentType = "example",
                Roles = Array.Empty<string>(),
            });

        Console.WriteLine(response.StatusCode);
    }
}

import com.sumup.sdk.SumUpClient;

public final class ListMembershipsSample {
  public static void main(String[] args) throws Exception {
    var client = new SumUpClient();

    var result = client.memberships().list();
    System.out.println(result);
  }
}

import os

import sumup

client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])
result = client.memberships.list(
    offset=0,
    limit=10,
    kind="merchant",
    status="accepted",
    resource_type="merchant",
    resource_parent_type="merchant",
    roles=[
        "role_employee",
        "role_accountant",
    ],
)
print(result)

<?php

declare(strict_types=1);

require __DIR__ . '/vendor/autoload.php';

$sumup = new \SumUp\SumUp('sup_sk_your_api_key');

$queryParams = new \SumUp\Services\MembershipsListParams();
$queryParams->offset = 0;
$queryParams->limit = 10;
$queryParams->kind = 'merchant';
$queryParams->status = 'accepted';
$queryParams->resourceType = 'merchant';
$queryParams->resourceParentType = 'merchant';
$queryParams->roles = [
    'role_employee',
    'role_accountant',
];

$result = $sumup->memberships()->list(
    $queryParams,
);

var_dump($result);

package main

import (
	"context"
	"fmt"

	"github.com/sumup/sumup-go"
)

func main() {
	client := sumup.NewClient()
	result, err := client.Memberships.List(context.TODO(), sumup.MembershipsListParams{
		Offset:             new(0),
		Limit:              new(10),
		Kind:               new(sumup.ResourceType("merchant")),
		Status:             new(sumup.MembershipStatus("accepted")),
		ResourceType:       new(sumup.ResourceType("merchant")),
		ResourceParentType: new(sumup.ResourceType("merchant")),
		Roles:              []string{"role_employee", "role_accountant"},
	})
	if err != nil {
		panic(err.Error())
	}

	fmt.Printf("%+v\n", result)
}

use sumup::{Authorization, Client};
#[tokio::main]
async fn main() {
    let client = Client::default()
        .with_authorization(Authorization::api_key("sup_sk_test_..."));
    let response = client
        .memberships()
        .list(sumup::resources::memberships::ListParams::builder().build())
        .await
        .expect("list request failed");
    println!("{response:#?}");
}

Response example

{
  "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"
      },
      "status": "accepted",
      "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
}

{
  "type": "https://developer.sumup.com/problem/bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Request validation failed."
}

{
  "type": "https://developer.sumup.com/problem/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials are missing or invalid."
}