Web Service Method: Request User Roles and Groups

18/03/2026

Description
Retrieve information about users (roles and groups) that have access to PoolParty.

You can collect information about all users. Alternatively you can select a specific user name to retrieve information about that user.

URL: /PoolParty/api/user

Supported Methods
GET

Parameter	Comment	Type	Required
names	Optional list of users for which details are requested	String	false

http status code 200 if OK.

JSON formatted response:

Attribute	Type	Comment
name	String	The name of the user which is used for authentication.
uri	uri	The URI of the user
fullname	String	Full name of the user. Usually, this field consists of first and last name.
roles	List	List of assigned roles
groups	List	List of assigned groups

Basic Pattern

https://<server-url>/PoolParty/api/user?names=<user-names>

In this section: