{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/users.json","auth":"required","basic_auth":false,"method":"get","params":[{"name":"page","type":"int","default":"","desc":"Indicates the page of users to return. Used when paging through users. Example: page=2.","required":false,"in":"query","ref":"","_id":"605a4e971b46bc007dd2fbf4"},{"name":"num_per_page","type":"int","default":"","desc":"Controls the number of users returned per page. Defaults to 50 users. Example: num_per_page=5.","required":false,"in":"query","ref":"","_id":"605a4e971b46bc007dd2fbf5"},{"name":"letter","type":"string","default":"","desc":"Filter users beginning with the given character. Example: letter=c.","required":false,"in":"query","ref":"","_id":"605a5350431451005edfbc3d"},{"name":"reverse","type":"boolean","default":"","desc":"Reverses the order of results returned. Example: reverse=true.","required":false,"in":"query","ref":"","_id":"605a5350431451005edfbc3e"},{"name":"sort_by","type":"string","default":"","desc":"Sort results by number of messages or followers, instead of the default behavior of sorting alphabetically. Examples: sort_by=[messages] or sort_by=[followers].","required":false,"in":"query","ref":"","_id":"605a549bc1be8e006dd0e975"},{"name":"show_pending","type":"boolean","default":"","desc":"By default, only active users are returned. The show_pending user will include pending users that have not activated their Yammer account. The pending user state is deprecated and only active users are present in M365 Native Mode networks.","required":false,"in":"query","ref":"","_id":"605a62cbebd4d1003c207824"}],"results":{"codes":[]},"try":true,"examples":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"/users.json","type":"endpoint","slug":"usersjson","excerpt":"","body":"The users endpoint returns a list of users within the network which can be paged through to get all users in the network. This endpoint will work in freemium and enterprise networks. \n\nMany developers will find that there are better solutions for getting user data:\n\n- [Azure Active Directory PowerShell for Graph](https://docs.microsoft.com/en-us/powershell/module/azuread/) module which is the recommended way for getting user data for Microsoft 365 users. All users in a Native Mode network are valid Azure AD users.\n- [Data Export API](https://developer.yammer.com/docs/data-export-api) which allows all users to be retrieved quickly in large networks without paging through many API responses.\n- [Autocomplete](https://developer.yammer.com/v1.0/docs/autocompleteranked) which enables lookup of individual users quickly. Example usage might be in a user lookup feature where the name of a user is being input.\n\nThese solutions are more efficient for common use cases arising during development and avoid the need to manage rate-limiting.\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":["565367df1b93fd2d00e55291","58088bc00576b40f000a5d96"],"order":26,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"547fb4aa3031bc0800e5ff49","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"},"createdAt":"2014-12-04T01:11:06.839Z","__v":16,"parentDoc":null,"user":"5433099f9a2b451a00ad4531","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"},"project":"545137a814af501a00b50cf9","githubsync":""}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

page:
integer
Indicates the page of users to return. Used when paging through users. Example: page=2.
num_per_page:
integer
Controls the number of users returned per page. Defaults to 50 users. Example: num_per_page=5.
letter:
string
Filter users beginning with the given character. Example: letter=c.
reverse:
boolean
Reverses the order of results returned. Example: reverse=true.
sort_by:
string
Sort results by number of messages or followers, instead of the default behavior of sorting alphabetically. Examples: sort_by=[messages] or sort_by=[followers].
show_pending:
boolean
By default, only active users are returned. The show_pending user will include pending users that have not activated their Yammer account. The pending user state is deprecated and only active users are present in M365 Native Mode networks.

Documentation

The users endpoint returns a list of users within the network which can be paged through to get all users in the network. This endpoint will work in freemium and enterprise networks. Many developers will find that there are better solutions for getting user data: - [Azure Active Directory PowerShell for Graph](https://docs.microsoft.com/en-us/powershell/module/azuread/) module which is the recommended way for getting user data for Microsoft 365 users. All users in a Native Mode network are valid Azure AD users. - [Data Export API](https://developer.yammer.com/docs/data-export-api) which allows all users to be retrieved quickly in large networks without paging through many API responses. - [Autocomplete](https://developer.yammer.com/v1.0/docs/autocompleteranked) which enables lookup of individual users quickly. Example usage might be in a user lookup feature where the name of a user is being input. These solutions are more efficient for common use cases arising during development and avoid the need to manage rate-limiting. ## Supported network types ## - Freemium/Basic - Enterprise without Native Mode - Enterprise with M365 Native Mode (Azure AD PowerShell or APIs are recommended for user operations.)