{"_id":"582789abbe5c080f00a5a82d","__v":0,"user":"573b7f42fdc9d320001b777d","category":{"_id":"582789abbe5c080f00a5a806","version":"582789aabe5c080f00a5a7fe","project":"568bdc1483d2061900d86cdc","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-17T20:31:36.079Z","from_sync":false,"order":8,"slug":"clients","title":"Clients"},"parentDoc":null,"version":{"_id":"582789aabe5c080f00a5a7fe","__v":10,"project":"568bdc1483d2061900d86cdc","createdAt":"2016-11-12T21:29:14.915Z","releaseDate":"2016-11-12T21:29:14.915Z","categories":["582789abbe5c080f00a5a7ff","582789abbe5c080f00a5a800","582789abbe5c080f00a5a801","582789abbe5c080f00a5a802","582789abbe5c080f00a5a803","582789abbe5c080f00a5a804","582789abbe5c080f00a5a805","582789abbe5c080f00a5a806","582789abbe5c080f00a5a807","582789abbe5c080f00a5a808","5827ea984ca29e0f00137a9e","583df597887db62f00644283","583df5d9c622791900e78da5","5845cd8763c11b250037967d","5845d13063c11b2500379681","5859e859e3306d1900126725","587aeb9a01cf3a0f008359eb","587c422af45e2d0f005e200d","587d84dc82f6f30f004ceee5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"beta2","version_clean":"0.0.0","version":"0"},"project":"568bdc1483d2061900d86cdc","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-31T01:06:33.543Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"items\": [\n    {\n      \"id\": \"L574cea940ac9f7726607b96a\",\n      \"ecosystemId\": \"C573b86eeee43dd7ba0244f8a\",\n      \"type\": \"server\",\n      \"name\": \"test client\",\n      \"description\": \"a client created to test the ability to create clients\",\n      \"createdAt\": \"2016-05-31T01:34:48.172Z\"\n    }\n  ]\n}"},{"name":"","code":"{\n  \"errorType\": \"InvalidParams\",\n  \"errors\": [\n    {\n      \"in\": \"query\",\n      \"message\": \"invalid id\",\n      \"path\": \"ecosystemId\"\n    }\n  ]\n}","language":"json","status":400},{"status":401,"language":"text","code":""},{"status":403,"language":"text","code":""},{"status":404,"language":"text","code":"Ecosystem with id C573b86eeee43dd7ba0244f8b does not exist"}]},"settings":"572c39957c8eff0e00aaa18b","examples":{"codes":[{"language":"http","code":"GET https://ioe.droplit.io/api/serviceclasses?ecosystemId=C573b86eeee43dd7ba0244f8a HTTP/1.1\nauthorization: AUTH_TOKEN"}]},"method":"get","auth":"required","params":[{"_id":"574ce6d06f075519007da3b3","ref":"","in":"path","required":true,"desc":"parent [ecosystem](doc:ecosystems) id","default":"","type":"string","name":"ecosystemId"}],"url":"/clients?ecosystemId=:ecosystemId"},"isReference":true,"order":0,"body":"This endpoint lists all clients for the specified ecosystem.","excerpt":"List all clients","slug":"list-clients","type":"endpoint","title":"List"}

getList

List all clients

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ecosystemId:
required
string
parent [ecosystem](doc:ecosystems) id

Examples


Result Format


Documentation

This endpoint lists all clients for the specified ecosystem.

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