Users
Find users by email
Changed onFind users by email. Only available to admin users. Also available when bypassing permissions.
get/users/find-email
Request
- Base URLhttps://example.com/api
- Auth
- OAuth 2Authorization codehttps://example.com/oauth2/authorizeToken URLhttps://example.com/api/oauth2/tokenScopesuser:read
- or API key in header XF-Api-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
emailstring required
Response
OK
Changes
- breaking
the
queryrequest parameteremailbecame required
- breaking
- info
api operation id
get_users_find_emailremoved and replaced withgetUsersFindEmail - info
the endpoint scheme security
XF-Api-Keywas added to the API - info
the endpoint scheme security
XF-OAuth2was added to the API - info
added the new optional
headerrequest parameterXF-Api-Userto all path's operations - info
added the new optional
queryrequest parameterapi_bypass_permissionsto all path's operations
- info