SUsumup
Roles

Retrieve a role

Changed on

Retrieve a custom role by ID.

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

Request

  • Base URL
    https://api.sumup.com
  • URL
    https://api.sumup.com/v0.1/merchants/{merchant_code}/roles/{role_id}
  • 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.

role_idstring required
Example:role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP

The ID of the role to retrieve.

Response

Returns the Role object for a valid identifier.

idstring required

Unique identifier of the role.

namestring required

User-defined name of the role.

descriptionstring

User-defined description of the role.

permissionsstring[] required

List of permission granted by this role.

is_predefinedboolean required

True if the role is provided by SumUp.

metadataMetadata

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.

created_atstring date-time required

The timestamp of when the role was created.

updated_atstring date-time required

The timestamp of when the role was last updated.

Example response

{
  "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