GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Actions51

Overview

The "Identities: List" operation in this node allows users to retrieve a list of all identities associated with a specific project. This is useful for managing and auditing user or platform identities within a messaging gateway environment. For example, if you want to see all registered identities linked to your project to analyze user engagement or synchronize identity data with another system, this operation provides a straightforward way to fetch that information.

Properties

Name Meaning
Project The identifier of the project to list identities from.

Output

The output JSON contains an array of identity objects representing all identities for the specified project. Each identity object typically includes details such as identity ID, display name, email, metadata, and associated platform aliases. This structured data enables further processing or integration with other workflows.

The node does not output binary data for this operation.

Dependencies

  • Requires an API key credential for authentication to the GateKit service.
  • The node makes HTTP GET requests to the endpoint /api/v1/projects/{project}/identities where {project} is the provided project identifier.
  • The base URL and authentication headers are configured via the node credentials.

Troubleshooting

  • Missing or invalid project identifier: Ensure the "Project" property is set correctly; otherwise, the API will return an error indicating the project was not found.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions to access identities.
  • Network issues: Check connectivity to the GateKit API endpoint.
  • Empty results: If no identities are returned, confirm that the project actually has identities registered.

Links and References

Discussion