{"_id":"56c419ea6063071700500cfe","__v":9,"project":"56bc8e679afb8b0d00d62dcf","user":"56b98db7bb36440d0001f492","version":{"_id":"56bc8e689afb8b0d00d62dd2","project":"56bc8e679afb8b0d00d62dcf","__v":18,"createdAt":"2016-02-11T13:36:40.146Z","releaseDate":"2016-02-11T13:36:40.146Z","categories":["56bc8e689afb8b0d00d62dd3","56c3c837bc41330d009f25ed","56c3c83e521f350d00d348eb","56c3c8452d97560d00e23cd8","56c3c85234df460d00c2beb8","56c4180d70187b17005f43b4","56c418162d97560d00e23cf6","56c4181cc4796b0d007ef039","56c4182370187b17005f43b5","56c418292e75e01700986052","56c4183328bd680d005e7ac6","56c4183bbb64720d00552b88","56c418414040602b0064cea0","56c4184754b6030d00ec29a1","56c4184c28bd680d005e7ac7","56c4185370187b17005f43b6","56c4185b6063071700500cfc","582a98b6f8c0a0190053d7a5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","parentDoc":null,"category":{"_id":"56c4181cc4796b0d007ef039","version":"56bc8e689afb8b0d00d62dd2","__v":26,"project":"56bc8e679afb8b0d00d62dcf","pages":["56c4192dbc41330d009f25fd","56c4196434df460d00c2bece","56c419814f0aed1700afaba6","56c4198dbc41330d009f25ff","56c419962e75e01700986053","56c4199f54b6030d00ec29a4","56c419a8bb64720d00552b8b","56c419b1bb64720d00552b8d","56c419b92d97560d00e23cf9","56c419c64040602b0064cea3","56c419d4bc41330d009f2601","56c419de70187b17005f43b9","56c419ea6063071700500cfe","56c419fa54b6030d00ec29a6","56c41a096063071700500d00","56c41a1834df460d00c2bed0","56c41a773d30210d00ea8517","56c41a86c4796b0d007ef03e","56c41a904f0aed1700afaba8","56c41a9fbc41330d009f2603","56c41aaa521f350d00d348fe","56c41abb4040602b0064cea5","56c41ad24040602b0064cea7","56c41ade48213b1700af6e28","56c41aeb3d30210d00ea8519","56c41af948213b1700af6e2a"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-17T06:50:04.339Z","from_sync":false,"order":2,"slug":"users","title":"Users"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-17T06:57:46.741Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":12,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"/users/lists\"\n}\n[/block]\nSearches all visible `UserLists` from an application.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var options = {\\n\\tlocationRange: \\\"47.1, -122.3, 10000\\\",\\n\\tname: \\\"The Name\\\",\\n\\tsortOrder: \\\"-{sortingParameter}\\\",\\n\\townerID: \\\"bvc.nqgbvzkcrDlr\\\",\\n\\ttoken: \\\"10;20\\\"\\n};\\n\\nBuddy.get('/users/lists',\\n\\t\\toptions,\\n\\t\\tfunction(err, result) {\\n\\t\\t\\t \\n\\t\\t\\tif (result.success) {\\n\\t\\t\\t\\t// Do something with the result!\\n\\t\\t\\t} else { \\n\\t\\t\\t\\t// Otherwise log the error\\n\\t\\t\\t\\tconsole.log(err); \\n\\t\\t\\t} \\n\\t\\t}\\n\\t);\",\n      \"language\": \"javascript\",\n      \"name\": null\n    },\n    {\n      \"code\": \"NSDictionary *params = :::at:::{\\n\\t\\t\\[email protected]\\\"locationRange\\\": BPCoordinateRangeMake(47.1, -121.292, 2500),\\n\\t\\t\\[email protected]\\\"name\\\": @\\\"The Name\\\",\\n\\t\\t\\[email protected]\\\"sortOrder\\\": @\\\"-{sortingParameter}\\\",\\n\\t\\t\\[email protected]\\\"ownerID\\\": @\\\"bvc.nqgbvzkcrDlr\\\",\\n\\t\\t\\[email protected]\\\"token\\\": @\\\"10;20\\\"\\n\\t\\t};\\n\\n[Buddy GET:@\\\"/users/lists\\\" parameters:params class:[BPPagedResult class] callback:^(id obj, NSError *error) {\\n\\t// Your callback code here\\n}];\",\n      \"language\": \"objectivec\",\n      \"name\": \"iOS\"\n    },\n    {\n      \"code\": \"Map<String, Object> parameters = new HashMap<String, Object>();\\nparameters.put(\\\"locationRange\\\", myLocationRange);\\nparameters.put(\\\"name\\\", \\\"The Name\\\");\\nparameters.put(\\\"sortOrder\\\", \\\"-{sortingParameter}\\\");\\nparameters.put(\\\"ownerID\\\", \\\"bvc.nqgbvzkcrDlr\\\");\\nparameters.put(\\\"token\\\", \\\"10;20\\\");\\n\\nBuddy.get(\\\"/users/lists\\\", parameters, new BuddyCallback<PagedResult>(PagedResult.class) {\\n\\[email protected]\\n\\tpublic void completed(BuddyResult<PagedResult> result) {\\n\\t\\tList<User> resultList = result.getResult().convertPageResults(User.class);\\n\\t\\t// Your callback code here\\n\\t}\\n});\",\n      \"language\": \"java\",\n      \"name\": \"Android\"\n    },\n    {\n      \"code\": \"var options = new {\\n\\t\\t\\tlocationRange = new BuddyGeoLocationRange(47.1, -122.3, 5000),\\n\\t\\t\\tname = \\\"The Name\\\",\\n\\t\\t\\tsortOrder = \\\"-{sortingParameter}\\\",\\n\\t\\t\\townerID = \\\"bvc.nqgbvzkcrDlr\\\",\\n\\t\\t\\ttoken = \\\"10;20\\\"\\n\\t\\t};\\n\\nvar result = await Buddy.GetAsync<PagedResult<User>>(\\\"/users/lists\\\", options);\",\n      \"language\": \"csharp\",\n      \"name\": \".NET\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Body Parameters\n\nThese parameters should be specified as part of the request body.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"locationRange\",\n    \"0-1\": \"Specifies the location and range to search as {latitude}, {longitude}, {range in meters}, for example 47.1,-122.3,10000. Note: there is a maximum searchable radius of 20,000 meters.\",\n    \"1-0\": \"name\",\n    \"2-0\": \"sortOrder\",\n    \"3-0\": \"ownerID\",\n    \"4-0\": \"token\",\n    \"1-1\": \"The name of the userList.\",\n    \"2-1\": \"Specifies the order in which a collection of results should be returned. To use this parameter, identify the parameter to sort on and prepend it with \\\"+\\\" to sort the results on field in ascending order or \\\"-\\\" for descending order (e.g. specifying \\\"+firstName\\\" will sort the results on the first name of each record, in ascending order).\",\n    \"3-1\": \"The Buddy ID of the user who owns (created) this object.\",\n    \"4-1\": \"Specifies the current page of results to obtain in a multi-page result set. The token can be obtained from a search result set by looking at the currentToken, nextToken, and previousToken result values which, when used in a subsequent search, will return the current, next, and previous page of results. Paging can be specified manually in the format \\\"{limit};{skip}\\\", where \\\"10;20\\\" would dictate a \\\"page limit of 10, skipping the first 20 results.\\\"\",\n    \"0-2\": \"string\",\n    \"1-2\": \"string\",\n    \"2-2\": \"string\",\n    \"4-2\": \"string\",\n    \"3-2\": \"buddyId\",\n    \"0-3\": \"Required\",\n    \"1-3\": \"Optional\",\n    \"2-3\": \"Optional\",\n    \"3-3\": \"Optional\",\n    \"4-3\": \"Optional\"\n  },\n  \"cols\": 4,\n  \"rows\": 5\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"status\\\": 200,\\n  \\\"result\\\": {\\n    \\\"currentToken\\\": \\\"W3siQXBwSUQiOiJiYmJiYmMuRGRoYnZmTGhLZ0RuIiwiT2JqZWN0VHlwZU5hbWUiOiJMaWdodHdlaWdodENvbGxlY3Rpb24iLCJQYXJlbnRPYmplY3RJRCI6bnVsbCwiUmVxdWVzdGluZ1VzZXJJRCI6ImJ2LmtDaGJ2c2hkSG5EbiIsIk93bmVyVXNlcklEIjpudWxsLCJMb2NhdGlvbiI6bnVsbCwiU2VhcmNoRGlzdGFuY2VJbk1ldGVycyI6MCwiU2VhcmNoUHJvcGVydGllcyI6W3siU29ydE9yZGVyIjowLCJQcm9wZXJ0eU5hbWUiOiJDYXRlZ29yeSIsIlByb3BlcnR5VmFsdWUiOiJVc2VyTGlzdCIsIlNlYXJjaE9wZXJhdGlvbiI6MH1dLCJQcm9wZXJ0eVNvcnQiOltdLCJNYXhSZXN1bHRzIjoxMDAsIlNraXAiOjAsIlBlcm1pc3Npb25zVG9Vc2UiOjN9LCIxMDA7MCIsIjIwMTQtMDctMTBUMjA6NTM6MTMuNDU3Il01\\\",\\n    \\\"pageResults\\\": [\\n      {\\n        \\\"name\\\": \\\"my list\\\",\\n        \\\"readPermissions\\\": \\\"User\\\",\\n        \\\"writePermissions\\\": \\\"User\\\",\\n        \\\"id\\\": \\\"blv.cLgbvdBjghqp\\\",\\n        \\\"created\\\": \\\"/Date(1405023987973)/\\\",\\n        \\\"lastModified\\\": \\\"/Date(1405023987973)/\\\"\\n      }\\n    ]\\n  },\\n  \\\"request_id\\\": \\\"53befd39b32fad0db41a80bf\\\",\\n  \\\"success\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"search-userlists","type":"basic","title":"Search UserLists"}
[block:api-header] { "type": "get", "title": "/users/lists" } [/block] Searches all visible `UserLists` from an application. [block:code] { "codes": [ { "code": "var options = {\n\tlocationRange: \"47.1, -122.3, 10000\",\n\tname: \"The Name\",\n\tsortOrder: \"-{sortingParameter}\",\n\townerID: \"bvc.nqgbvzkcrDlr\",\n\ttoken: \"10;20\"\n};\n\nBuddy.get('/users/lists',\n\t\toptions,\n\t\tfunction(err, result) {\n\t\t\t \n\t\t\tif (result.success) {\n\t\t\t\t// Do something with the result!\n\t\t\t} else { \n\t\t\t\t// Otherwise log the error\n\t\t\t\tconsole.log(err); \n\t\t\t} \n\t\t}\n\t);", "language": "javascript", "name": null }, { "code": "NSDictionary *params = @{\n\t\t\[email protected]\"locationRange\": BPCoordinateRangeMake(47.1, -121.292, 2500),\n\t\t\[email protected]\"name\": @\"The Name\",\n\t\t\[email protected]\"sortOrder\": @\"-{sortingParameter}\",\n\t\t\[email protected]\"ownerID\": @\"bvc.nqgbvzkcrDlr\",\n\t\t\[email protected]\"token\": @\"10;20\"\n\t\t};\n\n[Buddy GET:@\"/users/lists\" parameters:params class:[BPPagedResult class] callback:^(id obj, NSError *error) {\n\t// Your callback code here\n}];", "language": "objectivec", "name": "iOS" }, { "code": "Map<String, Object> parameters = new HashMap<String, Object>();\nparameters.put(\"locationRange\", myLocationRange);\nparameters.put(\"name\", \"The Name\");\nparameters.put(\"sortOrder\", \"-{sortingParameter}\");\nparameters.put(\"ownerID\", \"bvc.nqgbvzkcrDlr\");\nparameters.put(\"token\", \"10;20\");\n\nBuddy.get(\"/users/lists\", parameters, new BuddyCallback<PagedResult>(PagedResult.class) {\n\[email protected]\n\tpublic void completed(BuddyResult<PagedResult> result) {\n\t\tList<User> resultList = result.getResult().convertPageResults(User.class);\n\t\t// Your callback code here\n\t}\n});", "language": "java", "name": "Android" }, { "code": "var options = new {\n\t\t\tlocationRange = new BuddyGeoLocationRange(47.1, -122.3, 5000),\n\t\t\tname = \"The Name\",\n\t\t\tsortOrder = \"-{sortingParameter}\",\n\t\t\townerID = \"bvc.nqgbvzkcrDlr\",\n\t\t\ttoken = \"10;20\"\n\t\t};\n\nvar result = await Buddy.GetAsync<PagedResult<User>>(\"/users/lists\", options);", "language": "csharp", "name": ".NET" } ], "sidebar": true } [/block] ###Body Parameters These parameters should be specified as part of the request body. [block:parameters] { "data": { "0-0": "locationRange", "0-1": "Specifies the location and range to search as {latitude}, {longitude}, {range in meters}, for example 47.1,-122.3,10000. Note: there is a maximum searchable radius of 20,000 meters.", "1-0": "name", "2-0": "sortOrder", "3-0": "ownerID", "4-0": "token", "1-1": "The name of the userList.", "2-1": "Specifies the order in which a collection of results should be returned. To use this parameter, identify the parameter to sort on and prepend it with \"+\" to sort the results on field in ascending order or \"-\" for descending order (e.g. specifying \"+firstName\" will sort the results on the first name of each record, in ascending order).", "3-1": "The Buddy ID of the user who owns (created) this object.", "4-1": "Specifies the current page of results to obtain in a multi-page result set. The token can be obtained from a search result set by looking at the currentToken, nextToken, and previousToken result values which, when used in a subsequent search, will return the current, next, and previous page of results. Paging can be specified manually in the format \"{limit};{skip}\", where \"10;20\" would dictate a \"page limit of 10, skipping the first 20 results.\"", "0-2": "string", "1-2": "string", "2-2": "string", "4-2": "string", "3-2": "buddyId", "0-3": "Required", "1-3": "Optional", "2-3": "Optional", "3-3": "Optional", "4-3": "Optional" }, "cols": 4, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"status\": 200,\n \"result\": {\n \"currentToken\": \"W3siQXBwSUQiOiJiYmJiYmMuRGRoYnZmTGhLZ0RuIiwiT2JqZWN0VHlwZU5hbWUiOiJMaWdodHdlaWdodENvbGxlY3Rpb24iLCJQYXJlbnRPYmplY3RJRCI6bnVsbCwiUmVxdWVzdGluZ1VzZXJJRCI6ImJ2LmtDaGJ2c2hkSG5EbiIsIk93bmVyVXNlcklEIjpudWxsLCJMb2NhdGlvbiI6bnVsbCwiU2VhcmNoRGlzdGFuY2VJbk1ldGVycyI6MCwiU2VhcmNoUHJvcGVydGllcyI6W3siU29ydE9yZGVyIjowLCJQcm9wZXJ0eU5hbWUiOiJDYXRlZ29yeSIsIlByb3BlcnR5VmFsdWUiOiJVc2VyTGlzdCIsIlNlYXJjaE9wZXJhdGlvbiI6MH1dLCJQcm9wZXJ0eVNvcnQiOltdLCJNYXhSZXN1bHRzIjoxMDAsIlNraXAiOjAsIlBlcm1pc3Npb25zVG9Vc2UiOjN9LCIxMDA7MCIsIjIwMTQtMDctMTBUMjA6NTM6MTMuNDU3Il01\",\n \"pageResults\": [\n {\n \"name\": \"my list\",\n \"readPermissions\": \"User\",\n \"writePermissions\": \"User\",\n \"id\": \"blv.cLgbvdBjghqp\",\n \"created\": \"/Date(1405023987973)/\",\n \"lastModified\": \"/Date(1405023987973)/\"\n }\n ]\n },\n \"request_id\": \"53befd39b32fad0db41a80bf\",\n \"success\": true\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block]