Actions8
Overview
The "Pulse People" node interacts with the People resource of the Pulse API. Specifically, the Get People list operation retrieves a paginated list of people from the Pulse system, optionally including related resources and applying filters or sorting.
This node is useful in scenarios where you want to:
- Fetch a list of users or contacts managed within Pulse.
- Retrieve people data for reporting, synchronization, or further processing.
- Apply filters to narrow down the list based on criteria like organization ID.
- Include related resources such as associated accounts to enrich the data.
For example, you might use this node to get all people belonging to certain organizations, sorted by name, and include their account details for a CRM integration workflow.
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 (sort) |
String specifying the sort order of the results (e.g., "name asc"). |
- Page Number (pageNumber) |
Number indicating which page of results to retrieve (pagination). Default is 1. |
- Page Size (pageSize) |
Number indicating how many results per page to return. Default is 10. |
- Filters (filters) |
One or more filter key-value pairs to restrict the results. Each filter has: |
• Filter Key (key) |
The field name to filter by (e.g., "organization_id"). |
• Values (values) |
Comma-separated string of values to match for the filter key (e.g., "1,2,3"). |
- Fields (fields) |
Specify which fields to include in the response for nested resources. Each field entry has: |
• Field Key (key) |
The nested resource or path (e.g., "iam/organizations/people_directories"). |
• Fields (fields) |
Comma-separated list of field names to include (e.g., "id,name"). |
Output
The node outputs an array of JSON objects representing people records retrieved from the Pulse API. Each item contains the person’s data fields as returned by the API, potentially enriched with included related resources if requested.
If binary data were involved (not applicable here), it would be summarized accordingly, 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 service being accessible and properly configured.
- Pagination and filtering depend on the API's support for these features.
Troubleshooting
- Common issues:
- Invalid or missing API credentials will cause authentication errors.
- Requesting unsupported filters or fields may result in API errors.
- Pagination parameters out of range could lead to empty results or errors.
- Error messages:
"The operation "getPeopleList" is not supported for resource "people"!"indicates a misconfiguration of operation or resource.- Network or API errors will typically propagate as error messages in the node output.
- Resolutions:
- Verify API credentials and permissions.
- Check that filter keys and field names are valid according to Pulse API documentation.
- Adjust pagination parameters to valid ranges.
Links and References
- Pulse API Documentation (hypothetical link)
- n8n Documentation on Creating Custom Nodes
- General REST API Pagination Concepts: https://restfulapi.net/pagination/