Actions8
- Organizations Actions
- People Directories Actions
Overview
This node interacts with the "People Directories" resource of the Pulse API, specifically supporting operations to retrieve people directory entries. The "Get People Directory" operation fetches detailed information about a specific people directory entry by its ID. It can optionally include related resources such as the associated person or organization in the response.
This node is useful in scenarios where you need to integrate organizational directory data into workflows, for example:
- Retrieving contact details or organizational info for a given directory entry.
- Enriching CRM or HR systems with up-to-date directory data.
- Automating reporting or notifications based on people directory contents.
Properties
| Name | Meaning |
|---|---|
| People Directory ID * | The unique identifier of the people directory entry to retrieve. |
| Include Related Resources | Optional list of related resources to include in the response. Options: Person, Organization |
Output
The node outputs JSON data representing the people directory entry requested. The structure typically includes fields describing the directory entry itself and, if requested, embedded objects for related resources such as the person or organization linked to that directory entry.
If binary data were involved (not indicated here), it would be summarized accordingly, but this node focuses on JSON data output.
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 within n8n.
- No additional external dependencies are indicated.
Troubleshooting
Common issues:
- Invalid or missing People Directory ID will cause the API call to fail.
- Network or authentication errors if the API key is invalid or expired.
- Requesting related resources without proper permissions may result in incomplete data or errors.
Error messages:
"The operation "getPeopleDirectoryById" is not supported for resource "peopleDirectories"!"indicates a misconfiguration of the operation or resource parameters.- API errors returned from Pulse API will be passed through; check the error message for details like "Not Found" or "Unauthorized".
Resolutions:
- Verify the People Directory ID is correct and exists.
- Ensure the API key credential is valid and has necessary scopes.
- Confirm network connectivity and API endpoint availability.
Links and References
- Pulse API Documentation (hypothetical link)
- n8n documentation on creating custom nodes
- General API integration best practices