AGENT LIST

Returns all agents assigned to the business unit High-level organizational grouping used to manage technical support, billing, and global settings for your CXone Mpower system., unless in an array containing each agent’s profile information. Can return information about a specific agent by inputting an agent ID in the AgentID property. The following fields are returned in the variable specified in the ListVar parameter: • BusinessUnitID • UserName • MiddleName • Email • TeamId • ReportToId • ReportToMiddleName • IsSupervisor • LastModified • Custom1 • Custom3 • Custom5 • AgentID • FirstName • LastName • IsActive • TeamName • ReportToFirstName • ReportToLastName • LastLogin • Location • Custom2 • Custom4 • InternalId You might use this action to check if a specific agent is active, find the agent’s email address, check which team they belong to, or a variety of other custom options. Agent List is one of the available APIs you can use within Studio. You must have Framework actions and permissions enabled on your business unit in order to leverage this action.

Dependencies

• Always make sure that the SetSecurityUser action precedes this action and the output variable of that action matches the SecurityUser input variable of the Agent List action properties.

• This is an API action, located on the API Actions palette.

Supported Script Types

Generic	Email	Chat	Phone	Voicemail	Work Item	SMS

Input Properties

These properties define data that the action uses when executing.

Property	Description
Add Caption	Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon.
Security User	The output value of the SetSecurityUser action which authenticates a selected agent based on their permissions in the security profile. This field accepts variable formatted with curly brackets ( { } ). The default value is SecurityUser (same default output value of SetSecurityUser).
Agent Id	The agent ID. You can use a variable for this field, such as {agentId}. When blank, all users associated with the tenant High-level organizational grouping used to manage technical support, billing, and global settings for your CXone Mpower system. are returned in an array. In Value Mode: Enter the agent ID or click the plus + or minus - buttons to add an ID number. In Expression Mode: Enter the agent ID.

Output Properties

These properties contain variables that hold data returned from executing the action. They're available for reference and use when the action completes.

Property	Description
ListVar	Holds the returned data. The contents of this variable are stored as an array. The default value is Agents, but it can be modified to whatever value is desired.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition	Description
Default	Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.
Success	Path taken if the action completes without errors and any API calls or data returns were successful (2xx response codes).
InvalidAgentId	Path taken if the Agent ID is invalid.
InvalidSecurityUser	Path taken when an invalid security user is used.

Other Options

Depending on the data you want to obtain, additional API actions may be helpful. For example, All Agent Skill Assignments, Agent States V4, Get Agents List, Get Agent Details by Agent ID, and so forth.