{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/open_graph_objects","auth":"required","results":{"codes":[]},"settings":"","examples":{"codes":[{"language":"text","code":""}]},"method":"get","params":[{"name":"url","type":"string","default":"","desc":"URL identifying the Open Graph Object.","required":false,"in":"query","ref":"","_id":"59b2e74d0d38c8001078508f"}]},"next":{"description":"","pages":[]},"title":"/open_graph_objects","type":"endpoint","slug":"open_graph_objects","excerpt":"Description","body":"Retrieve Open Graph Object (web link) metadata for a specific URL by making a request to `/api/v1/open_graph_objects` with the URL specified as a query parameter. Example:\n\n`https://www.yammer.com/api/v1/open_graph_objects?url=https://portal.office.com`\n\nOnly a single Open Graph Object exists in each Yammer Network for an absolute URL (web link).\n\nThis web link is publicly available within your network, but the messages associated with it is only public to users who have access to the conversations the Open Graph Object was a part of.\"\n\nIf an Open Graph Object exists, metadata including the unique identifier for use with the [Open Graph messages endpoint](https://developer.yammer.com/v1.0/docs/messagesopen_graph_objects) will be returned.\n\nIf no Open Graph Object exists, then a 404 Not Found response will be returned.","updates":[],"order":52,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c82eb1a5e2b30001fadc0be","project":"545137a814af501a00b50cf9","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"},"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"},"user":"55497660c634cf2d001250a6","createdAt":"2019-03-08T22:22:18.403Z","__v":17,"parentDoc":null}

get/open_graph_objects

Description

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

url:
string
URL identifying the Open Graph Object.

Documentation

Retrieve Open Graph Object (web link) metadata for a specific URL by making a request to `/api/v1/open_graph_objects` with the URL specified as a query parameter. Example: `https://www.yammer.com/api/v1/open_graph_objects?url=https://portal.office.com` Only a single Open Graph Object exists in each Yammer Network for an absolute URL (web link). This web link is publicly available within your network, but the messages associated with it is only public to users who have access to the conversations the Open Graph Object was a part of." If an Open Graph Object exists, metadata including the unique identifier for use with the [Open Graph messages endpoint](https://developer.yammer.com/v1.0/docs/messagesopen_graph_objects) will be returned. If no Open Graph Object exists, then a 404 Not Found response will be returned.