{"_id":"5480fbd8ea7fd40b00cd7c27","parentDoc":null,"version":{"_id":"545137a814af501a00b50cfc","project":"545137a814af501a00b50cf9","__v":11,"createdAt":"2014-10-29T18:53:28.525Z","releaseDate":"2014-10-29T18:53:28.525Z","categories":["545137a814af501a00b50cfd","545138eaa66f020800dbab4a","546b9072b47b5d1400109edf","546b9082b47b5d1400109ee0","546b9088b47b5d1400109ee1","546b909462515a14007ebc43","546b90a0b47b5d1400109ee2","546ced235884600e007a92f6","5481008eea7fd40b00cd7c2b","573b9d83ee2b3b220042291f","57be1efa15efc70e006a5f99"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"546b909462515a14007ebc43","project":"545137a814af501a00b50cf9","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"],"version":"545137a814af501a00b50cfc","__v":56,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2014-11-18T18:31:48.943Z","from_sync":false,"order":2,"slug":"rest-api","title":"REST API"},"githubsync":"","user":"5433099f9a2b451a00ad4531","editedParams2":true,"project":"545137a814af501a00b50cf9","__v":4,"editedParams":true,"updates":["59b850fb43d4820010c67520"],"next":{"pages":[],"description":""},"createdAt":"2014-12-05T00:27:04.129Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"method":"get","results":{"codes":[]},"try":true,"examples":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"5480fbd8ea7fd40b00cd7c2a","ref":"","in":"query","required":false,"desc":"The search query.","default":"","type":"file","name":"search"},{"_id":"5480fbd8ea7fd40b00cd7c29","ref":"","in":"query","required":false,"desc":"Only 20 results of each type will be returned for each page, but a total count is returned with each query. page=1 (the default) will return items 1-20, page=2 will return items 21-30, etc.","default":"","type":"int","name":"page"},{"_id":"5480fbd8ea7fd40b00cd7c28","ref":"","in":"query","required":false,"desc":"This allows you to limit the number of results of each type per page, up to a maximum of 20, the default value.","default":"","type":"int","name":"num_per_page"},{"_id":"59bafd779b240e003c41ea8c","ref":"","in":"query","required":false,"desc":"","default":"","type":"int","name":"search_group"}],"url":"/search.json"},"isReference":true,"order":46,"body":"The example below searches for “”.\n\nThe search resource will return a list of messages, users, topics and groups that match the user’s search query.","excerpt":"","slug":"searchjson","type":"endpoint","title":"/search.json"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

search:
file
The search query.
page:
integer
Only 20 results of each type will be returned for each page, but a total count is returned with each query. page=1 (the default) will return items 1-20, page=2 will return items 21-30, etc.
num_per_page:
integer
This allows you to limit the number of results of each type per page, up to a maximum of 20, the default value.
search_group:
integer

Documentation

The example below searches for “”. The search resource will return a list of messages, users, topics and groups that match the user’s search query.

User Information

Note: Do not use this token in your app; you'll need to get the OAuth token yourself.

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}