Actions51
- Platforms Actions
- Projects Actions
- Webhooks Actions
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs Actions
Overview
The "Identities: Lookup" operation in this node allows you to find an identity within a project by specifying a platform configuration ID and a provider-specific user ID. This is useful when you want to retrieve the internal identity record that corresponds to a user on a particular messaging or social platform integrated into your system.
Typical use cases include:
- Mapping external platform users to internal identities for unified user management.
- Retrieving identity details before sending messages or performing other operations related to that user.
- Synchronizing user data across multiple platforms by resolving their unique platform IDs.
For example, if you have a Telegram user ID and the corresponding platform configuration ID, you can look up the associated identity in your project to get metadata or linked aliases.
Properties
| Name | Meaning |
|---|---|
| Platform configuration ID | The unique identifier of the platform configuration where the user exists. |
| Provider-specific user ID | The user ID specific to the platform (e.g., Telegram user ID) used to identify the user. |
| Project | The project identifier within which to perform the lookup (default is "default"). |
Output
The output JSON will contain the identity information found by the lookup operation. This typically includes fields such as the identity's internal ID, display name, email, metadata, and any linked platform aliases.
The node does not output binary data for this operation.
Dependencies
- Requires an API key credential configured with access to the GateKit API.
- The node makes HTTP GET requests to the endpoint
/api/v1/projects/{project}/identities/lookupwith query parametersplatformIdandproviderUserId. - The project parameter must correspond to an existing project in the GateKit system.
Troubleshooting
- Identity Not Found: If no identity matches the given platform ID and user ID, the API may return an empty result or an error. Verify that the platform ID and provider user ID are correct and exist in the specified project.
- Authentication Errors: Ensure that the API key credential is valid and has permissions to access the identities resource.
- Invalid Project: Confirm that the project identifier is correct and that the project exists.
- Malformed Input: Make sure the platform ID and provider user ID are provided as strings and correctly formatted.