Looks up end users. Exactly one lookup type must be provided per request:
email: searches across all email-based authentication methods (email, Google, Apple, GitHub). May return multiple end users if the same email address appears across different auth methods.
oauthProvider + oauthSubject: looks up a user by their OAuth
provider and subject (the sub claim from the provider’s ID token).
Both params must be provided together.
phoneNumber: looks up a user by their SMS-verified phone number.
Returns all matching end users. If no end users match, an empty array is returned.
This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.
A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.
The email address to search for across all email-based authentication methods.
The OAuth provider to search by. Must be provided together with oauthSubject. The type of OAuth2 provider.
google, apple, x, telegram, github "google"
The OAuth subject (the sub claim from the provider's ID token). Must be provided together with oauthProvider.
The E.164-formatted phone number to search for. Must be URL-encoded when passed as a query parameter (e.g. +14155552671 → %2B14155552671).
^\+[1-9]\d{1,14}$Successfully looked up end users.
The list of end users matching the lookup.