List all roles

1 min

GET

https://api.upstartcommerce.com/profile-permissions/roles

Returns all roles, optionally filtered by scope, tenant, site, and/or role type.

Required Permission: profile-permissions.roles.list

scopestringFilter by role scope (GLOBAL, TENANT, or SITE)

tenantIdstringFilter by tenant ID (applicable when scope=TENANT or SITE)

siteIdstringFilter by site ID (applicable when scope=SITE)

roleTypestringFilter by role type

acceptstringGenerated from available response content types

200List of roles

401Missing or invalid authentication token

500Internal server error

curl --request GET \
     --url https://api.upstartcommerce.com/profile-permissions/roles \
     --header 'accept: application/json'