Actions52
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs Actions
- Platforms Actions
- Projects Actions
- Webhooks Actions
Overview
This node provides integration with a universal messaging gateway platform, allowing users to manage various messaging-related resources within projects. Specifically, the Identities - List operation retrieves all identities associated with a specified project. Identities represent user profiles linked across multiple messaging platforms.
Use cases include:
- Retrieving all user identities for a project to analyze or synchronize user data.
- Managing user profiles centrally when integrating multiple messaging platforms.
- Building workflows that require fetching identity lists for further processing or reporting.
Example: You want to get a list of all identities in your "default" project to send targeted messages or update user metadata.
Properties
| Name | Meaning |
|---|---|
| Project | The identifier of the project to operate on. This specifies which project's identities to list. |
Output
The node outputs a JSON array containing the list of identities for the specified project. Each identity object typically includes details such as identity ID, display name, email, metadata, and linked platform aliases.
The output structure is:
[
{
"id": "string",
"displayName": "string",
"email": "string",
"metadata": { /* JSON object */ },
"aliases": [ /* array of platform alias objects */ ],
...
},
...
]
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential configured in n8n to authenticate requests to the messaging gateway API.
- The node uses the base URL and authentication headers from the configured credentials.
- The project identifier must correspond to an existing project in the messaging gateway system.
Troubleshooting
- Invalid project identifier: If the project does not exist or is misspelled, the API will return an error. Verify the project name is correct.
- Authentication errors: Ensure the API key credential is valid and has permissions to access the identities resource.
- Empty results: If no identities are returned, confirm that the project contains identities or that you have access rights.
- Network issues: Check connectivity to the messaging gateway API endpoint.
Links and References
- Messaging Gateway API Documentation (generic): Refer to your messaging gateway provider's API docs for detailed information about the identities endpoint.
- n8n Credential Setup: https://docs.n8n.io/credentials/overview/
- n8n HTTP Request Node (for custom calls): https://docs.n8n.io/nodes/n8n-nodes-base.httpRequest/