Pulse Office Action icon

Pulse Office Action

Office actions from Pulse API

Actions17

Overview

The node "Pulse Office Action" integrates with the Pulse API to manage various office-related resources such as employees, announcements, holidays, leave requests, and planning. Specifically, for the Employee resource with the Get Employee List operation, it retrieves a list of employees from the Pulse system. This can be useful in scenarios where you want to automate workflows involving employee data retrieval, such as syncing employee directories, generating reports, or feeding employee information into other systems.

For example, you might use this node to:

  • Fetch all employees along with their planning and leave budget details.
  • Retrieve paginated employee lists filtered by organization or department.
  • Sort employee data based on specific fields like name or hire date.

Properties

Name Meaning
Include Related Resources (included) Select related resources to include in the response. Options: Planning, Leave Budget.
Additional Fields (additionalFields) Collection of optional parameters to customize the request:
- Sort The sort order to apply to the employee list (e.g., ascending by name).
- Page Number Pagination page number to retrieve (default is 1).
- Page Size Number of employees per page (default is 10).
- Filters Filters to narrow down the employee list. Each filter has a key (e.g., organization_id) and comma-separated values (e.g., 1,2,3).
- Fields Specify which fields to include in the response. Each field entry has a key (e.g., iam/organizations/people_directories) and comma-separated field names (e.g., id,name).

Output

The output is a JSON object containing the employee list data retrieved from the Pulse API. The structure typically includes employee details and any related resources requested via the "Include Related Resources" property.

  • The json output field contains the employee data array and metadata such as pagination info.
  • No binary data output is expected for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Pulse API.
  • The node depends on the Pulse API helper utilities bundled within the node's codebase.
  • Proper configuration of the API credential in n8n is necessary for successful execution.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect filter keys or values may result in empty responses or errors.
    • Requesting unsupported related resources or fields could lead to API errors.
    • Pagination parameters out of range may return no results.

  • Error Messages:

    • "Unknown operation: "getEmployeeList" is not supported for resource "employee"!" — indicates a misconfiguration of the operation or resource.
    • API errors returned from Pulse (e.g., unauthorized, bad request) will be surfaced in the node’s error output.

  • Resolutions:

    • Verify that the API key credential is correctly set up and has sufficient permissions.
    • Double-check filter keys and values against Pulse API documentation.
    • Use valid options for included related resources.
    • Adjust pagination parameters to valid ranges.

Links and References

Discussion