Pulse Organizations icon

Pulse Organizations

Organizations actions from Pulse API

Actions8

Overview

This node interacts with the "People Directories" resource of the Pulse API, specifically supporting the operation to List People Directories. It retrieves a list of people directories from the Pulse system, optionally including related resources and applying filters or sorting.

Common scenarios where this node is beneficial include:

  • Fetching an overview of all people directories available in an organization.
  • Retrieving directories along with related persons or organizations for enriched data processing.
  • Filtering and sorting directories based on specific criteria such as creation date or custom fields.

Practical example:

  • An HR automation workflow that lists all people directories sorted by creation date and includes associated persons to send targeted notifications.

Properties

Name Meaning
Include Related Resources (included) Select which related resources to include in the response. Options: Person, Organization. This allows fetching additional linked data alongside the people directories.
Additional Fields (additionalFields) A collection of optional parameters to customize the listing:
- Sort: Specify sort order by field name (e.g., "created_at" ascending or "-created_at" descending).
- Filters: Apply one or more filters by specifying key-value pairs to narrow down results.
- Fields: Define which fields to include in the response for specified resource types by providing comma-separated field names.

Output

The node outputs JSON data representing the list of people directories retrieved from the Pulse API. The structure typically includes:

  • Directory metadata such as ID, name, description, creation date, etc.
  • If requested via included property, related resources like persons or organizations are embedded within the output.
  • The output is an array of directory objects matching the applied filters and sorting.

No binary data output is produced by this node.

Dependencies

  • Requires connection to the Pulse API service.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • No other external dependencies are required.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect filter keys or values may result in empty responses or errors.
    • Unsupported sort field names can lead to API errors.

  • Error messages:

    • "The operation "listPeopleDirectories" is not supported for resource "peopleDirectories"!": Indicates a mismatch in operation or resource selection; verify correct configuration.
    • API errors returned from Pulse API (e.g., unauthorized, bad request) should be checked against the provided credentials and input parameters.

  • Resolution tips:

    • Ensure the API key credential is valid and has necessary permissions.
    • Double-check filter keys and sort fields against Pulse API documentation.
    • Use the "Continue On Fail" option in n8n to handle errors gracefully during batch executions.

Links and References

Discussion