API REFERENCE

User Roles API

This is a read-only view that pairs each user with the roles assigned to them. Use it to answer "who holds which roles" in one call rather than walking every user individually.

Reading the join

GET /user-roles returns users with their roles attached. It does not change anything. To assign or remove a role, go through POST /users/{id}/roles on the Users API; to read a role's own definition and permissions, use the Roles API.

curl
curl -G https://algapsa.com/api/v1/user-roles \
  -H "X-API-Key: $ALGA_API_KEY" \
  --data-urlencode "search=admin" \
  --data-urlencode "is_inactive=false" \
  --data-urlencode "limit=50"

The view paginates with page and limit, filters by search and is_inactive, and accepts sort / order for ordering — enough to drive a periodic access review that pages through everyone and flags who still holds elevated roles.

Endpoints

Every endpoint links through to its full parameters, request and response schemas, and code samples.

GET/api/v1/user-rolesAlgaPSAList users with roles