{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"never","try":true,"basic_auth":false,"params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"About the Yammer REST API","type":"basic","slug":"rest-api-rate-limits","excerpt":"","body":"The Yammer REST API enables message posting, feed access, and many other capabilities. It supports both [Yammer OAuth 2 (legacy)](https://developer.yammer.com/docs/oauth-2) and [Azure Active Directory (AAD)](https://techcommunity.microsoft.com/t5/yammer-blog/yammer-api-with-aad-tokens-postman-collection/ba-p/857923) tokens.\n\n### Versioning  ###\n\nOnly version 1.0 endpoints are supported. You should avoid using APIs which are not documented on this site because they are subject to change at any time.\n\nThe API version is shown in the URLs of the endpoint e.g. /api/v1.\n\n### Admin Actions ###\n\nIn order to perform administrative API actions, such as creating and deleting users, the access token should belong to a verified admin user in paid Yammer networks.\n\n### Response format ###\n\nYammer can return JSON or XML in API responses. When no extension is provided, some older endpoints may default to returning XML.  It is **strongly recommended** that you use the JSON response format at all times.\n\nDevelopers should expect that new elements or attributes may be added to the API responses. The ordering of items within the data structures is not guaranteed. \n\nFor example, the order of the foo and bar items in the excerpts below might be swapped in the same version of the API:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{ \\\"things\\\": { \\\"foo\\\": \\\"Foo!\\\", \\\"bar\\\": \\\"Bar!\\\" } }\",\n      \"language\": \"text\",\n      \"name\": \"JSON\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<things><foo>Foo!</foo> <bar>Bar!</bar></things>\",\n      \"language\": \"text\",\n      \"name\": \"XML\"\n    }\n  ]\n}\n[/block]\nIf elements are removed, we will typically release a new version of the API. \n\n## Getting Bulk Content ##\n\nThe [Data Export API](https://developer.yammer.com/docs/data-export-api) is the recommended option for getting content in bulk, such as fetching all message content for a group in a compliance or analytics app.\n\nContrast the Data Export API with the messages REST endpoint which returns a subset of messages. All messages may not be returned because threads can have a very large number of messages. This difference a benefit when developing a responsive end user application which is the focus of the REST API.\n\nApplication which need frequent access to Yammer content should aggressively cache API responses to avoid repeat requests for the same data.","updates":["55e83de9fd7184190086e1c4","55fb76fa6ce9600d0071e4ba","577b26d26e5f301900fad91b","5787a106e516ba0e003045f9","579a8f6df29e970e006358cf","589dde3bad98aa3900d15761","5c6420cf6d4d880370280d4b"],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"546fdf54a179880800187e8b","githubsync":"","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-11-22T00:56:52.354Z","user":"5433099f9a2b451a00ad4531","parentDoc":null,"__v":29,"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"}

About the Yammer REST API


The Yammer REST API enables message posting, feed access, and many other capabilities. It supports both [Yammer OAuth 2 (legacy)](https://developer.yammer.com/docs/oauth-2) and [Azure Active Directory (AAD)](https://techcommunity.microsoft.com/t5/yammer-blog/yammer-api-with-aad-tokens-postman-collection/ba-p/857923) tokens. ### Versioning ### Only version 1.0 endpoints are supported. You should avoid using APIs which are not documented on this site because they are subject to change at any time. The API version is shown in the URLs of the endpoint e.g. /api/v1. ### Admin Actions ### In order to perform administrative API actions, such as creating and deleting users, the access token should belong to a verified admin user in paid Yammer networks. ### Response format ### Yammer can return JSON or XML in API responses. When no extension is provided, some older endpoints may default to returning XML. It is **strongly recommended** that you use the JSON response format at all times. Developers should expect that new elements or attributes may be added to the API responses. The ordering of items within the data structures is not guaranteed. For example, the order of the foo and bar items in the excerpts below might be swapped in the same version of the API: [block:code] { "codes": [ { "code": "{ \"things\": { \"foo\": \"Foo!\", \"bar\": \"Bar!\" } }", "language": "text", "name": "JSON" } ] } [/block] [block:code] { "codes": [ { "code": "<things><foo>Foo!</foo> <bar>Bar!</bar></things>", "language": "text", "name": "XML" } ] } [/block] If elements are removed, we will typically release a new version of the API. ## Getting Bulk Content ## The [Data Export API](https://developer.yammer.com/docs/data-export-api) is the recommended option for getting content in bulk, such as fetching all message content for a group in a compliance or analytics app. Contrast the Data Export API with the messages REST endpoint which returns a subset of messages. All messages may not be returned because threads can have a very large number of messages. This difference a benefit when developing a responsive end user application which is the focus of the REST API. Application which need frequent access to Yammer content should aggressively cache API responses to avoid repeat requests for the same data.