{"_id":"5b5b51e1faf2c40003dbcda9","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":31,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c33affb2b45c0010b7aa23","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-21T04:07:27.858Z","from_sync":false,"order":25,"slug":"users-api","title":"Users API"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":11,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-27T17:09:53.154Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"59a85b6b02c545000f08a77f","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"items\": [\n    {\n      \"id\": \"C594b4a7e42a2ab152bca2195;demoAlias|595d5c8883fa9b12685bc0c1\",\n      \"meta\": {},\n      \"ecosystemId\": \"C594b4a7e42a2ab152bca2195\",\n      \"uniqueId\": \"demoAlias|595d5c8883fa9b12685bc0c1\",\n      \"email\": \"demo:::at:::droplit.io\",\n      \"createdAt\": \"2018-03-21T03:03:52.872Z\"\n    }\n  ]\n} ","name":""},{"status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"path\": \"ecosystemId\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}","name":"Ecosystem Invalid"},{"code":"{\n    \"errorType\": \"InvalidBody\",\n    \"errors\": [\n        {\n            \"path\": \"query\",\n            \"message\": \"Invalid input 'invalid' from filter 'invalid'. Expected 'AND','OR','NOR','NOT','EQUALS','NOTEQUALS','LESSTHAN','LESSTHANOREQUAL','GREATERTHAN','GREATERTHANOREQUAL','IN','NOTIN','TYPE','EXISTS','NOTEXISTS','CONTAINS','NCONTAINS' after ''\"\n        }\n    ]\n}","language":"json","name":"Filter Invalid","status":400},{"code":"Ecosystem with id C599343aebca5fb882a7a4197 does not exist.","language":"text","name":"Ecosystem Not Found","status":404}]},"examples":{"codes":[{"language":"http","code":"GET https://ioe.droplit.io/api/users/?ecosystemId=C594b4a7e42a2ab152bca2195&filter=eq(email, \"demo@droplit.io\") HTTP/1.1\nauthorization: AUTH_TOKEN"},{"code":"droplit user list","language":"text","name":"Console"},{"code":"droplit.users.list(\"C594b4a7e42a2ab152bca2195\", 'eq(email, \"demo@droplit.io\")');","language":"javascript","name":"Droplit SDK"}]},"method":"get","auth":"required","params":[{"_id":"59c33b44185f99001034dace","ref":"","in":"query","required":true,"desc":"The ID of the desired ecosystem.","default":"","type":"string","name":"ecosystemId"},{"_id":"5b5b4cf0eaf71700031c2acd","ref":"","in":"query","required":false,"desc":"Get only users whose properties fulfill the conditions of a [filter](doc:filters).","default":"","type":"string","name":"filter"},{"_id":"5b5b5298b22ba300037b3ec3","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"}],"url":"/"},"isReference":false,"order":0,"body":"An account token or server token may be used to run this endpoint.","excerpt":"Get all the users in an ecosystem. (user filters are still a bit wonky)","slug":"users-list","type":"endpoint","title":"List users."}

getList users.

Get all the users in an ecosystem. (user filters are still a bit wonky)

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

ecosystemId:
required
string
The ID of the desired ecosystem.
filter:
string
Get only users whose properties fulfill the conditions of a [filter](doc:filters).

Headers

authorization:
required
string
The user's authorization token.

Examples


Result Format


Documentation

An account token or server token may be used to run this endpoint.

User Information

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 }}