LoyaltyPlus
  1. Roles
LoyaltyPlus
  • Auth (No Auth Required)
    • Login - Get Token
      POST
    • Refresh Token
      POST
  • Accounts (Auth Required)
    • Roles
      • List
        GET
      • Create
        POST
      • Retrieve
        GET
      • Update
        PUT
      • Delete
        DELETE
    • Admin Users
      • List
      • Create
      • Retrieve
      • Update
      • Delete
    • 2FA Settings
      • List
      • Create
      • Retrieve
      • Update
      • Delete
    • API Keys
      • List
      • Create
      • Retrieve
      • Update
      • Delete
    • Webhooks
      • List
      • Create
      • Retrieve
      • Update
      • Delete
    • Webhook Events
      • List
      • Create
      • Retrieve
      • Update
      • Delete
    • Webhook Attempts
      • List
      • Create
      • Retrieve
      • Update
      • Delete
    • Audit Logs
      • List
      • Create
      • Retrieve
      • Update
      • Delete
    • Stores
      • List
      • Create
      • Retrieve
      • Update
      • Delete
    • Profile
      • me
    • Permissions
      • permissions
    • System-Logs
      • System logs
  1. Roles

List

GET
/roles
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/roles' \
--header 'x-api-key: d3b91a50-6cb9-46de-beb2-8a19b5ddfa68'
Response Response Example
{
    "success": true,
    "data": {
        "count": 3,
        "next": null,
        "previous": null,
        "results": [
            {
                "id": "4a09b243-754c-4292-a470-6bc0cc868390",
                "permission_details": [
                    {
                        "id": 153,
                        "codename": "add_reward",
                        "name": "Can add reward"
                    },
                    {
                        "id": 154,
                        "codename": "change_reward",
                        "name": "Can change reward"
                    },
                    {
                        "id": 155,
                        "codename": "delete_reward",
                        "name": "Can delete reward"
                    },
                    {
                        "id": 156,
                        "codename": "view_reward",
                        "name": "Can view reward"
                    },
                    {
                        "id": 149,
                        "codename": "add_rewardcategory",
                        "name": "Can add reward category"
                    },
                    {
                        "id": 150,
                        "codename": "change_rewardcategory",
                        "name": "Can change reward category"
                    },
                    {
                        "id": 151,
                        "codename": "delete_rewardcategory",
                        "name": "Can delete reward category"
                    },
                    {
                        "id": 152,
                        "codename": "view_rewardcategory",
                        "name": "Can view reward category"
                    }
                ],
                "created_at": "2025-04-06T08:46:42.706600-05:00",
                "updated_at": "2025-04-06T08:46:42.706641-05:00",
                "name": "RewardOperator",
                "description": "Manages rewards and issuing"
            },
            {
                "id": "ae55a700-e7a0-43c0-8c15-ed489032fb7a",
                "permission_details": [
                    {
                        "id": 96,
                        "codename": "view_role",
                        "name": "Can view role"
                    },
                    {
                        "id": 73,
                        "codename": "add_store",
                        "name": "Can add store"
                    },
                    {
                        "id": 74,
                        "codename": "change_store",
                        "name": "Can change store"
                    },
                    {
                        "id": 75,
                        "codename": "delete_store",
                        "name": "Can delete store"
                    },
                    {
                        "id": 76,
                        "codename": "view_store",
                        "name": "Can view store"
                    }
                ],
                "created_at": "2025-04-06T08:46:34.866111-05:00",
                "updated_at": "2025-04-06T08:46:34.866170-05:00",
                "name": "StoreManager",
                "description": "Manages store-level data"
            },
            {
                "id": "46af36a3-bd88-430a-95f2-f0f75fec0633",
                "permission_details": [
                    {
                        "id": 81,
                        "codename": "add_adminuser",
                        "name": "Can add admin user"
                    },
                    {
                        "id": 82,
                        "codename": "change_adminuser",
                        "name": "Can change admin user"
                    },
                    {
                        "id": 83,
                        "codename": "delete_adminuser",
                        "name": "Can delete admin user"
                    },
                    {
                        "id": 84,
                        "codename": "view_adminuser",
                        "name": "Can view admin user"
                    },
                    {
                        "id": 93,
                        "codename": "add_role",
                        "name": "Can add role"
                    },
                    {
                        "id": 95,
                        "codename": "delete_role",
                        "name": "Can delete role"
                    },
                    {
                        "id": 96,
                        "codename": "view_role",
                        "name": "Can view role"
                    }
                ],
                "created_at": "2025-04-06T08:43:31.124499-05:00",
                "updated_at": "2025-04-06T08:43:31.124525-05:00",
                "name": "SuperAdmin",
                "description": "Full system access"
            }
        ]
    },
    "message": "Request successful"
}

Request

Header Params

Responses

🟢200List
application/json
Body

Modified at 2025-04-07 21:10:50
Previous
Refresh Token
Next
Create
Built with