Access roles grant additional permissions to users beyond their base group access.
Each role is a named permission flag that can be added to or removed from a user independently. A user with no access roles assigned is considered to have a "Custom Role" with minimal permissions.
Access restriction: These endpoints are available to distributors only. The authenticated user must have the admin_user role.
Available role names:
-
admin_user— full administrative access -
trends— access to trend analytics -
catalog_management— catalog editing and management access
To assign roles at user creation time, include the access-roles relationship in the POST /users request body. Roles can also be added or removed independently via the /access-roles endpoints.
List access roles
Retrieve a paginated list of access roles. Returns access roles belonging to users within the managed groups of the authenticated user.
Requires: admin_user role.
query Parameters
page[number]Page number for pagination
page[size]Number of items per page (max 200)
includeComma-separated list of related resources to include
List access roles › Responses
Successful response