{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/users/by_email.json?email=:User_Email","auth":"required","params":[{"name":"User_Email","type":"string","default":"","desc":"User email address","required":false,"in":"path","ref":"","_id":"54bef8a66df9fe0d00bac4a3"}],"results":{"codes":[]},"try":true,"basic_auth":false,"method":"get","examples":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"/users/by_email.json?email=user:::at:::domain.com","type":"endpoint","slug":"usersby_emailjsonemailuserdomaincom","excerpt":"","body":"The get user by email address endpoint returns information for the current user, including user ID, name, and email. The user returned is determined based on the email address passed to the endpoint.\n\nThis endpoint can be surprising for developers who are unfamiliar with the architecture of Yammer networks. Therefore, developers should test with multiple network configurations to cover all use cases. Common situations include:\n\n- Multiple accounts for the same person existing due to sign-up with multiple email addresses and aliases.\n- Sign-up to Yammer with an alias that is different from the primary email or UPN.\n- Multiple networks existing in a 1:Many configuration which requires consolidation. When an email from the tenant is used, the user matching user might actually exist in a different network attached to the tenant.\n\nCare should be taken to protect any user data acquired by the application from this endpoint.\n\nIn a Native Mode network, the Yammer profile is a subset of information stored in Azure Active Directory. Further, Native Mode ensures that the problematic scenarios listed above do not exist. For this reason, application developers should consider whether Azure AD APIs may be more appropriate for their use case.\n\n## Supported network types ##\n- Freemium/Basic\n- Enterprise without Native Mode\n- Enterprise with M365 Native Mode (Azure AD PowerShell or APIs are recommended for user operations.)","updates":[],"order":29,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54809ecd5f83dd0800c38fd3","__v":5,"editedParams2":true,"category":{"sync":{"isSync":false,"url":""},"pages":["546fdf54a179880800187e8b","54738e24007eb108007e03ff","54738e7d1a20c70800e189b0","54738e8a007eb108007e0404","54738e9b1a20c70800e189b2","54738ec0007eb108007e0407","54738ed21a20c70800e189b5","54738ee2007eb108007e0414","54738f05007eb108007e0416","54738f23007eb108007e0418","54738f31007eb108007e041a","547f80f9b7c1e40800dcf46f","547f9758b7c1e40800dcf4c2","547f9a3f3031bc0800e5fec4","547fa5f63031bc0800e5fef3","547fa632b7c1e40800dcf4e9","547fa696b7c1e40800dcf4ec","547fa6cc3031bc0800e5fef6","547fab89b7c1e40800dcf511","547facedb7c1e40800dcf51f","547faeef3031bc0800e5ff2d","547fafb03031bc0800e5ff31","547fb05ab7c1e40800dcf52a","547fb07a3031bc0800e5ff38","547fb0c4b7c1e40800dcf531","547fb100b7c1e40800dcf535","547fb18c3031bc0800e5ff41","547fb2433031bc0800e5ff44","547fb2feb7c1e40800dcf539","547fb335b7c1e40800dcf53b","547fb4aa3031bc0800e5ff49","547fb4f4b7c1e40800dcf541","547fb553b7c1e40800dcf544","54809ecd5f83dd0800c38fd3","54809f715f83dd0800c38fd6","54809fa8a3e4ea22000976b7","54809fd3a3e4ea22000976ba","5480a00ba3e4ea22000976bc","5480f44dea7fd40b00cd7c06","5480f4fb0e664d0b00be35f9","5480f5a5ea7fd40b00cd7c0b","5480f607ea7fd40b00cd7c10","5480f657ea7fd40b00cd7c12","5480f69a0e664d0b00be35ff","5480f77aea7fd40b00cd7c14","5480f7e7ea7fd40b00cd7c18","5480f83dea7fd40b00cd7c1b","5480f950ea7fd40b00cd7c1e","5480f9a6ab84321d00eaf538","5480faa8ea7fd40b00cd7c22","5480fb0aea7fd40b00cd7c25","5480fbd8ea7fd40b00cd7c27","5480fc64ab84321d00eaf53c","54c01ec89290010d00934956","55581594e54fe019002a4f2c","556e8b29fc3aa80d00e1a953"],"title":"REST API","slug":"rest-api","order":2,"from_sync":false,"reference":true,"_id":"546b909462515a14007ebc43","project":"545137a814af501a00b50cf9","version":"545137a814af501a00b50cfc","__v":56,"createdAt":"2014-11-18T18:31:48.943Z"},"editedParams":true,"project":"545137a814af501a00b50cf9","createdAt":"2014-12-04T17:50:05.459Z","githubsync":"","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["545137a814af501a00b50cfd","545138eaa66f020800dbab4a","546b9072b47b5d1400109edf","546b9082b47b5d1400109ee0","546b9088b47b5d1400109ee1","546b909462515a14007ebc43","546b90a0b47b5d1400109ee2","546ced235884600e007a92f6","5481008eea7fd40b00cd7c2b","573b9d83ee2b3b220042291f","57be1efa15efc70e006a5f99","5ee004f52c97b4004c7a5876"],"_id":"545137a814af501a00b50cfc","project":"545137a814af501a00b50cf9","__v":12,"createdAt":"2014-10-29T18:53:28.525Z","releaseDate":"2014-10-29T18:53:28.525Z"},"parentDoc":null,"user":"5433099f9a2b451a00ad4531"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

User_Email:
string
User email address

Documentation

The get user by email address endpoint returns information for the current user, including user ID, name, and email. The user returned is determined based on the email address passed to the endpoint. This endpoint can be surprising for developers who are unfamiliar with the architecture of Yammer networks. Therefore, developers should test with multiple network configurations to cover all use cases. Common situations include: - Multiple accounts for the same person existing due to sign-up with multiple email addresses and aliases. - Sign-up to Yammer with an alias that is different from the primary email or UPN. - Multiple networks existing in a 1:Many configuration which requires consolidation. When an email from the tenant is used, the user matching user might actually exist in a different network attached to the tenant. Care should be taken to protect any user data acquired by the application from this endpoint. In a Native Mode network, the Yammer profile is a subset of information stored in Azure Active Directory. Further, Native Mode ensures that the problematic scenarios listed above do not exist. For this reason, application developers should consider whether Azure AD APIs may be more appropriate for their use case. ## Supported network types ## - Freemium/Basic - Enterprise without Native Mode - Enterprise with M365 Native Mode (Azure AD PowerShell or APIs are recommended for user operations.)