SUsumup
Roles

List roles

Changed on

List merchant's custom roles.

get/v0.1/merchants/{merchant_code}/roles

Request

  • Base URL
    https://api.sumup.com
  • URL
    https://api.sumup.com/v0.1/merchants/{merchant_code}/roles
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.sumup.com/authorize
      Token URL: https://api.sumup.com/token scopes: user.subaccounts, roles.read

Path parameters

merchant_codestring required
Example:MK10CL2A

Short unique identifier for the merchant.

Response

Returns a list of Role objects.

Example response

{
  "items": [
    {
      "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"
    }
  ]
}

Changes

  • c75ca16e1e44Revision changes
    • info

      the security scope roles.read was added to the endpoint's security scheme oauth2

    • info

      the security scope user.subaccounts was added to the endpoint's security scheme oauth2

  • cd79d83b07e0Revision changes
    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status