Sign in
Roles

List roles

List merchant's custom roles.

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

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

Changed in 4 of the 53 revisions of this API.5

  • c75ca16e1e442See the full diff
    • ○

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

      api-security-scope-added

    • ○

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

      api-security-scope-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cd79d83b07e01See the full diff
    • ○

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

      response-media-type-name-specialized

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b8fb7c9463b81See the full diff
    • ○

      added the media type application/json for the response with the status 404

      response-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 80a17713e7a81See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog