Actions8
- People Actions
- Person Identity Document Actions
Overview
The node interacts with the "People" resource of the Pulse API, specifically supporting operations such as retrieving a list of people. The "Get People list" operation fetches multiple person records from the Pulse system, optionally including related resources and applying filters, pagination, sorting, and field selection.
This node is useful in scenarios where you need to integrate Pulse's people data into workflows, for example:
- Synchronizing user directories or contact lists.
- Generating reports based on filtered subsets of people.
- Automating onboarding processes by fetching people data dynamically.
Properties
| Name | Meaning |
|---|---|
Include Related Resources (included) |
Select related resources to include in the response. Options: Account. |
Additional Fields (additionalFields) |
Collection of optional parameters to customize the request: |
| - Sort | String specifying the sort order of the results. |
| - Page Number | Number indicating which page of results to retrieve (pagination). |
| - Page Size | Number indicating how many results per page to return (pagination). |
| - Filters | One or more filters to apply to the request. Each filter has a key and comma-separated values. |
| - Fields | Specify fields to include in the response. Each entry has a field key and comma-separated field names. |
Output
The output is an array of JSON objects representing people records retrieved from the Pulse API. Each item corresponds to one person and includes the requested fields and any included related resources (e.g., account information if selected).
If binary data were supported, it would be summarized here, but this operation returns only JSON data.
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 package.
- No additional external dependencies are required beyond the configured API authentication.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Using unsupported filter keys or invalid filter values may result in errors or empty responses.
- Requesting pages beyond the available range will return empty results.
- Specifying invalid field keys in the "Fields" property may cause incomplete data or errors.
Error messages:
"The operation "getPeopleList" is not supported for resource "people"!"— indicates a misconfiguration of the operation name."The resource "..." is not supported!"— indicates an invalid resource selection.- Network or API errors will typically propagate with their message; ensure network connectivity and valid API endpoint configuration.
To resolve these, verify credentials, check property values carefully, and consult the Pulse API documentation for valid filter keys and field names.
Links and References
- Pulse API Documentation (hypothetical link)
- n8n Documentation on Creating Custom Nodes
- General API Pagination Concepts: https://swagger.io/docs/specification/2-0/describing-responses/#pagination