{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/user","auth":"required","settings":"","examples":{"codes":[]},"method":"get","params":[{"name":"page","type":"int","default":"1","desc":"The pagination number.","required":false,"in":"query","ref":"","_id":"55460fff6bea270d0047d4c6"},{"name":"page_size","type":"int","default":"10","desc":"The number of users per page.","required":false,"in":"query","ref":"","_id":"55460fff6bea270d0047d4c5"},{"name":"ids","type":"string","default":"","desc":"A comma-separated list of user IDs to retrieve.","required":false,"in":"query","ref":"","_id":"571d59727643b90e00249978"},{"name":"vanity_name","type":"string","default":"","desc":"Filter posts by a specific user's vanity name.","required":false,"in":"query","ref":"","_id":"571d5e1b18b3c10e003e55d1"}],"results":{"codes":[{"code":"{ }","status":200,"language":"text"}]}},"next":{"description":"","pages":[]},"title":"/user","type":"endpoint","slug":"blog","excerpt":"","body":"Get an array of CS Blogs users. All parameters are optional.","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"571d58d11bbe64200055f01c","parentDoc":null,"version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["571d54d418b3c10e003e55ba","571d54d418b3c10e003e55bb","571d54d418b3c10e003e55bc","586982e31c8ac62300359a78","5869833f6dab552500c677cb"],"_id":"571d54d418b3c10e003e55b9","project":"54fb204867c8370d00b5c269","hasDoc":true,"hasReference":true,"__v":3,"releaseDate":"2016-04-24T23:20:52.805Z","createdAt":"2016-04-24T23:20:52.805Z"},"__v":3,"project":"54fb204867c8370d00b5c269","user":"54fb2a5f3dc1790d00b54206","editedParams2":true,"editedParams":true,"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Users API","slug":"users-api","order":2,"from_sync":false,"reference":false,"_id":"586982e31c8ac62300359a78","project":"54fb204867c8370d00b5c269","version":"571d54d418b3c10e003e55b9","__v":0,"createdAt":"2017-01-01T22:29:55.939Z"},"createdAt":"2016-04-24T23:37:53.792Z"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

page:
integer1
The pagination number.
page_size:
integer10
The number of users per page.
ids:
string
A comma-separated list of user IDs to retrieve.
vanity_name:
string
Filter posts by a specific user's vanity name.

Result Format


Documentation

Get an array of CS Blogs users. All parameters are optional.

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