RingCX Admin API Mock Server

▶ GET /sub-accounts List all sub accounts

▶ GET /agent-groups List agent groups

Filter by subAccountId (optional) 💡 SubAccount 52012209 returns ONLY 1 agent group (ID: 88146)

▶ GET /users/memberships Users with memberships (filter by hasRoles, roleType, subAccountIds)

Count (max 500)

hasRoles

roleType

subAccountIds (comma-separated)

Filter by hasRoles, roleType (Agent/Admin), or subAccountIds (comma-separated)

▶ GET /roles Available roles (filter by subAccountIds)

SubAccount IDs (optional, comma-separated) 💡 SubAccount 52012209 returns ONLY 1 Agent role (no Admin roles)

Role Type

▶ GET /user/:userId/roles Roles for specific user

User ID

Use IDs from /users/memberships or 165000001 (user without roles)

▶ GET /me/permissions Current user permissions (all subaccounts)

Returns all granted permissions with value=true

▶ GET /sub-accounts/:id/me/permissions Current user permissions (specific subaccount)

SubAccount ID

▶ POST /users-bulk/roles Assign/unassign roles (unified agents & admins)

SubAccount ID

skipConflicts (skip users with conflicting agent groups)

Agent Group ID (optional)

Only for agent roles. If provided and skipConflicts=false, conflicts will be checked.

Assign Role IDs (comma-separated, optional)

Can include hardcoded roles: GoodDataViewer, GoodDataAnalyst, GoodDataEditor, AccessAuditLog, ManageRights, ManageUsers

Unassign Role IDs (comma-separated, optional) Optional: Role IDs to remove. Can provide assignRoleIds, unassignRoleIds, or both.

User IDs (max 100)

💡 Returns 200 with assignment status (Success/Failure/Skip) for each user. Conflicts return Failure (skipConflicts=false) or Skip (skipConflicts=true).