Endpoints

The UMAPI includes endpoints for working with the following entities:

• agent attributes

• agent groups

• business units

• users

Agent-attribute endpoints

Endpoint	Method	URL	Description
Get agent attributes	GET	/v1/attribute/{siteId}	Retrieve an array of site agent attributes.

Agent-group endpoints

Endpoint	Method	URL	Description
Get agent groups	GET	/v1/agentGroups/{siteId}/listAg	Retrieve an array of agent groups.

Business-unit endpoints

Endpoint	Method	URL	Description
Get business units	GET	/v1/businessUnit/{siteId}	Retrieve an array of business units.

User endpoints

Endpoint	Method	URL	Description
Create user	POST	/v1/user/{siteId}	Create a new user.
Delete user	DELETE	/v1/user/{siteId}/{userId}	Delete a user by its user ID.
Get user	GET	/v1/user/{siteId}/{userId}	Get a user by its user ID.
Look up users	GET	/v1/user/{siteId}/filteredList	Retrieve an array of users.
Patch user	PATCH	/v1/user/{siteId}/{userId}	Partly update a user record, identified by its user ID, by a specified property value or attribute.
Update user	PUT	/v1/user/{siteId}/{userId}	Update a complete user record by its user ID.