Retrieve a role

GET/v0.1/merchants/{merchant_code}/roles/{role_id}

Retrieve a custom role by ID.

OAuth scopes: Requires one of: user.subaccounts, roles.read.

Required permissions:

roles_view

Authorization

Use one of the following alternatives:

apiKey
oauth2 with scopes user.subaccountsroles.read

Authorization guide

Path parameters

merchant_codestringrequired
Short unique identifier for the merchant.

Example: "MK10CL2A"
role_idstringrequired
The ID of the role to retrieve.

Example: "role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"

Responses

200application/json

Returns the Role object for a valid identifier.

idstringrequired
Unique identifier of the role.

Example: "role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
namestringrequired
User-defined name of the role.

Example: "Senior Shop Manager II"
permissionsarray<string>required
List of permission granted by this role.

Example: []
is_predefinedbooleanrequired
True if the role is provided by SumUp.

Example: true
created_atstringrequired
format: date-time
The timestamp of when the role was created.

Example: "2023-01-20T15:16:17Z"
updated_atstringrequired
format: date-time
The timestamp of when the role was last updated.

Example: "2023-01-20T15:16:17Z"
descriptionstring
User-defined description of the role.

Example: "Manges the shop and the employees."
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: {}

404application/problem+json

Merchant or role not found.

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.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

GET

Code sample

curl --request GET \
  --url https://api.sumup.com/v0.1/merchants/MK10CL2A/roles/role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP \
  --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.roles.get(
    "MK10CL2A",
    "role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
  );
  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.Roles.GetAsync(
            "your-merchant-code",
            "example-id");

        Console.WriteLine(response.StatusCode);
    }
}

import com.sumup.sdk.SumUpClient;

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

    var result = client.roles().get(
            "MK10CL2A",
            "role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
        );
    System.out.println(result);
  }
}

<?php

declare(strict_types=1);

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

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

$result = $sumup->roles()->get(
    'MK10CL2A',
    'role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP',
);

var_dump($result);

package main

import (
	"context"
	"fmt"

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

func main() {
	client := sumup.NewClient()
	result, err := client.Roles.Get(context.TODO(), "MK10CL2A", "role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP")
	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
        .roles()
        .get("MERCHANT_CODE", "ROLE_ID")
        .await
        .expect("get request failed");
    println!("{response:#?}");
}

Response example

{
  "id": "role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
  "name": "Senior Shop Manager II",
  "description": "Manges the shop and the employees.",
  "permissions": [],
  "is_predefined": true,
  "metadata": {},
  "created_at": "2023-01-20T15:16:17Z",
  "updated_at": "2023-01-20T15:16:17Z"
}

{
  "type": "https://developer.sumup.com/problem/not-found",
  "title": "Requested resource couldn't be found.",
  "status": 404,
  "detail": "The requested resource doesn't exist or does not belong to you."
}