Ecommerce

get roles

GET

{{host_user}}/roles

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '{{host_user}}/roles?query={"capabilities":{"$in": ["6790c5ef9e5c31f77fc0418e"]}}' \
--header 'x-client: {{client}}' \
--header 'x-access-token;'

Response Example

{
    "roles": [
        {
            "reserved": false,
            "capabilities": [
                "6790c62e573675dcc48b9c70",
                "6790c60e6b4cb01518ab428d",
                "6790c5ef9e5c31f77fc0418e",
                "6790c5b29e5c311b58c0417e"
            ],
            "_id": "6790dae9701ff0e096faa28d",
            "label": "Lead Manager",
            "name": "leadManager",
            "createdBy": "676bac072ae885370fd845e9",
            "__v": 0,
            "id": "6790dae9701ff0e096faa28d"
        }
    ],
    "pagination": {
        "totalPages": 1,
        "perPage": 40,
        "totalCount": 1
    }
}

Request

Authorization

API Key

Add parameter in header

x-access-token

Example:

x-access-token: ********************

Query Params

query

string

required

Example:

{"capabilities":{"$in": ["6790c5ef9e5c31f77fc0418e"]}}

Header Params

x-client

string

required

Example:

Responses

🟢200200 with query

application/json

Body

roles

array [object {8}]

required

reserved

boolean

optional

capabilities

array[string]

optional

_id

string

optional

label

string

optional

name

string

optional

createdBy

string

optional

__v

integer

optional

string

optional

pagination

object

required

totalPages

integer

required

perPage

integer

required

totalCount

integer

required

Modified at 2025-04-02 09:10:35

get all roles

get all capabilities