Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Uname → List Of Uname

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of agents (referred to as "Uname" in the resource). The "List Of Uname" operation fetches agent data filtered by various criteria such as department, team, role, status, and permissions. This is useful for workflows that need to manage or analyze user/agent information within the Halo PSA system.

Common scenarios:

  • Automating reporting on active or inactive agents.
  • Filtering agents by department or team for targeted notifications.
  • Retrieving agents with specific roles or qualifications for task assignments.
  • Integrating agent data into other systems or dashboards.

Practical example:
A support manager wants to generate a report of all active agents in the "IT Support" department who have exchange calendars synced and include their ticket counts. This node can be configured with appropriate filters to retrieve this data automatically.

Properties

Name Meaning
Activeinactive Takes two comma-separated values; the first sets whether to include active agents, the second sets whether to include inactive agents.
Appointmentscreen (No description provided)
Can Edit Only Boolean filter to include only agents that the user has permission to edit.
Client Id Integer filter to include agents belonging to a particular client.
Clientidoverride (No description provided)
Department Id Integer filter to include agents belonging to a particular department.
Departments Comma-separated string filter to include agents belonging to specified departments.
Domain String filter on agent permissions; possible values include 'opps', 'prjs', 'reqs'.
Exchangecalendars Boolean filter to include only agents that have Exchange calendars synced.
Exclude Agent Integer ID of an agent to exclude from the results.
Forcequalmatch (No description provided)
Includeapiagents (No description provided)
Includedisabled Boolean filter to include agents that are inactive in the response.
Includeenabled Boolean filter to include agents that are active in the response.
Includenamedcount Boolean to include the count of the number of agents in the response.
Includeroles Boolean to include agent roles in the response.
Includestatus Boolean to include agent status in the response.
Includeunassigned Boolean to include the unassigned agent in the response.
Integration Type String filter on agents that belong to a particular integration; e.g., 'okta'.
Linemanagedonly Boolean filter to include only agents that have a line manager.
Linkingagents (No description provided)
Loadcache (No description provided)
Onlinestatuses Comma-separated string filter on agents that have certain online statuses.
Qualifications Comma-separated string filter on agents with certain qualifications.
Reassign Boolean filter on agents that can assign tickets to agents in sections they are not members of.
Remoteagents Boolean filter related to agent invite permissions; matches agent ID if false.
Remoteagenttype String filter for remote agent invite permissions; possible values: 'beyondtrust', 'logmein'.
Role String filter by agents who have a particular role (expects integer passed as string).
Search String filter by agents with name, email address, or telephone number matching the search term.
Shiftagentsonly (No description provided)
Showall Boolean used to override organization restrictions for main search; admin only.
Showcounts Boolean to include agents' ticket counts in the response.
Team String filter by agents within a particular team.
Team Id Integer filter by agents within a particular team ID.
Teams Comma-separated string filter on agents that belong to specified teams.
This Agent Only Boolean to include only the current agent in the response.
Ticketarea Id Integer filter for ticket area; only applicable when showing counts.
Tickettype Id Integer filter for agents that have access to particular ticket types.
View Id Integer filter for ticket view; only applicable when showing counts.
Withemail Boolean filter to include only agents that have an email address.

Output

The node outputs JSON data containing the list of agents matching the specified filters. Each item in the output corresponds to one agent's data as returned by the Halo PSA API. Depending on the options selected, the response may include:

  • Basic agent details (e.g., name, ID).
  • Roles and status information.
  • Ticket counts if requested.
  • Additional metadata such as qualifications, teams, and permissions.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses the base URL, tenant identifier, client ID, and client secret from the credentials to make authenticated requests.
  • No additional external dependencies beyond the Halo PSA API and n8n's HTTP request capabilities.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API authentication credentials. Ensure that valid credentials are configured in n8n before running the node.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("Uname") and operation ("List Of Uname") are selected.

  • Invalid parameter values
    Some filters expect specific formats (e.g., integers as strings for role IDs). Providing incorrect types may cause API errors.

  • API request failures
    Network issues, invalid credentials, or API rate limits can cause request failures. Check connectivity and credential validity.

  • Continue on Fail behavior
    If enabled, the node will return error messages in the output JSON instead of stopping execution. Use this to handle partial failures gracefully.

Links and References

Discussion