{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/profiles/search","auth":"required","results":{"codes":[{"status":400,"language":"json","code":"For\tSingle\tUser\tsearch\tby\tUser\tId:\t\n{\t\n\t\t\"id\":\t\"f8179782-c5e1-4c0f-85e5-7db5ff6b0c8d\",\t\n\t\t\"first_name\":\t\"Sachin\",\t\n\t\t\"last_name\":\t\"Zope\",\t\n\t\t\"login_type\":\t\"credential\",\t\n\t\t\"parent_user_id\":\tnull,\t\n\t\t\"user_category\":\t\"student\",\t\n\t\t\"birth_date\":\tnull,\t\n\t\t\"grade\":\tnull,\t\n\t\t\"course\":\tnull,\t\n\t\t\"thumbnail\":\tnull,\t\n\t\t\"gender\":\t\"male\",\t\n\t\t\"about\":\t\"I\tam\tteacher\",\t\n\t\t\"school_id\":\tnull,\t\n\t\t\"school\":\tnull,\t\n\t\t\"school_district_id\":\tnull,\t\n\t\t\"school_district\":\tnull,\t\n\t\t\"email\":\t\"szgooru:::at:::gooru.org\",\t\n\t\t\"country_id\":\tnull,\t\n\t\t\"country\":\tnull,\n  \t\"state_id\":\tnull,\t\n\t\t\"state\":\tnull,\t\n\t\t\"metadata\":\tnull,\t\n\t\t\"roster_id\":\tnull,\t\n\t\t\"roster_global_userid\":\tnull,\t\n\t\t\"created_at\":\t\"2016-03-30T23:18:04Z\",\t\n\t\t\"updated_at\":\t\"2016-03-30T23:18:04Z\",\t\n\t\t\"followers\":\t0,\t\n\t\t\"followings\":\t0,\t\n\t\t\"isFollowing\":\tfalse,\t\n\t\t\"username\":\t\"szgooru\"\t\n}\t\n\t\nOR\t\n\t\nFor\tMultiple\tUser\tsearch\tby\tusers\tids \t\n{\t\n\t\t\"users\"\t:\t[\t\n{\t\n\t\t\"id\":\t\"f8179782-c5e1-4c0f-85e5-7db5ff6b0c8d\",\t\n\t\t\"first_name\":\t\"Sachin\",\t\n\t\t\"last_name\":\t\"Zope\",\t\n\t\t\"parent_user_id\":\tnull,\t\n\t\t\"user_category\":\t\"student\",\t\n\t\t\"birth_date\":\tnull,\t\n\t\t\"grade\":\tnull,\t\n\t\t\"course\":\tnull,\t\n\t\t\"thumbnail\":\tnull,\t\n\t\t\"gender\":\t\"male\",\t\n\t\t\"about\":\t\"I\tam\tteacher\",\t\n\t\t\"school_id\":\tnull,\t\n\t\t\"school\":\tnull,\t\n\t\t\"school_district_id\":\tnull,\t\n\t\t\"school_district\":\tnull,\t\n\t\t\"email\":\t\"szgooru@gooru.org\",\t\n\t\t\"country_id\":\tnull,\t\n\t\t\"country\":\tnull,\t\n\t\t\"state_id\":\tnull,\t\n\t\t\"state\":\tnull,\t\n\t\t\"metadata\":\tnull,\t\n\t\t\"roster_id\":\tnull,\t\n\t\t\"roster_global_userid\":\tnull,\t\n\t\t\"created_at\":\t\"2016-03-30T23:18:04Z\",\t\n\t\t\"updated_at\":\t\"2016-03-30T23:18:04Z\",\t\n\t\t\"username\":\t\"szgooru\"\t\n}\t\n\t\t]\t\n}\t","name":""},{"status":200,"language":"json","code":"{\t\n\t\t\"id\":\t\"f8179782-c5e1-4c0f-85e5-7db5ff6b0c8d\",\t\n\t\t\"first_name\":\t\"Sachin\",\t\n\t\t\"last_name\":\t\"Zope\",\t\n\t\t\"login_type\":\t\"credential\",\t\n\t\t\"parent_user_id\":\tnull,\t\n\t\t\"user_category\":\t\"student\",\t\n\t\t\"birth_date\":\tnull,\t\n\t\t\"grade\":\tnull,\t\n\t\t\"course\":\tnull,\t\n\t\t\"thumbnail\":\tnull,\t\n\t\t\"gender\":\t\"male\",\t\n\t\t\"about\":\t\"I\tam\tteacher\",\t\n\t\t\"school_id\":\tnull,\t\n\t\t\"school\":\tnull,\t\n\t\t\"school_district_id\":\tnull,\t\n\t\t\"school_district\":\tnull,\t\n\t\t\"email\":\t\"szgooru@gooru.org\",\t\n\t\t\"country_id\":\tnull,\t\n\t\t\"country\":\tnull,\t\n    \"state_id\":\tnull,\t\n\t\t\"state\":\tnull,\t\n\t\t\"metadata\":\tnull,\t\n\t\t\"roster_id\":\tnull,\t\n\t\t\"roster_global_userid\":\tnull,\t\n\t\t\"created_at\":\t\"2016-03-30T23:18:04Z\",\t\n\t\t\"updated_at\":\t\"2016-03-30T23:18:04Z\",\t\n\t\t\"followers\":\t0,\t\n\t\t\"followings\":\t0,\t\n\t\t\"isFollowing\":\tfalse,\t\n\t\t\"username\":\t\"szgooru\"\t\n}\t"}]},"settings":"","params":[{"name":"username","type":"string","default":"","desc":"Username to search","required":false,"in":"body","ref":"","_id":"5d538b76b5cb31002d679fca"},{"name":"email","type":"string","default":"","desc":"Email to search","required":false,"in":"body","ref":"","_id":"5d538b76b5cb31002d679fc9"},{"name":"userids","type":"array_string","default":"","desc":"Comma separated list of userids.\tMax\t50  User Ids supported","required":false,"in":"body","ref":"","_id":"5d538b76b5cb31002d679fc8"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Search User(s)","type":"endpoint","slug":"search-users","excerpt":"","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header Name\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"Authorization\",\n    \"0-1\": \"Token{TOKEN}\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]","updates":[],"order":14,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"5d42922e5e2515001fd0febe","project":"56439dfe9eebf70d00490d54","version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["5864d2df79ce642d00f0fec8","5864d2df79ce642d00f0fec9","5864d2df79ce642d00f0feca","5864d2df79ce642d00f0fecb","5864d2df79ce642d00f0fecc","5864d2df79ce642d00f0fecd","5864d2df79ce642d00f0fece","5864d2df79ce642d00f0fecf","5864d2df79ce642d00f0fed0","5864d2df79ce642d00f0fed1","5864d2df79ce642d00f0fed2","5864d2df79ce642d00f0fed3","5864d2df79ce642d00f0fed4","5864d2df79ce642d00f0fed5","5864d2df79ce642d00f0fed6","5864d2df79ce642d00f0fed7","5864d2df79ce642d00f0fed8","5864d2df79ce642d00f0fed9","5864d2df79ce642d00f0feda","5864d2df79ce642d00f0fedb","5864d2df79ce642d00f0fedc","5864d2df79ce642d00f0fedd","5864d2df79ce642d00f0fede","598aa64f4b6e990019b7a2d2","599bc76bc03fa2000f83db2a","599bcc3c3c5bf7000f3434fc","5d427dc9fa56fa0011135058","5d429c616863d5003af785a7","5d429e0889418f00c5e95d3f","5d42b5f098b05e003acb08b4","5d43c16985775c00ebeede3b","5d43d15446d584003da91e6d","5d43d61a5bdac50011b6f234","5d43d7c2db365100640dbc58","5d43d954bffa8400ff7efa78","5d43e414cf4f03005944344c","5d43eb42db365100640dbe4a","5d43ee6c78121b0057bc1dbf","5d9a18b4afc33400126c4e6f","5dc4f96dbb5da3006c8f5660"],"_id":"5864d2df79ce642d00f0fec7","createdAt":"2016-12-29T09:09:51.074Z","project":"56439dfe9eebf70d00490d54","releaseDate":"2016-12-29T09:09:51.074Z","__v":18},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Profile","slug":"profile","order":11,"from_sync":false,"reference":false,"_id":"5864d2df79ce642d00f0fed2","version":"5864d2df79ce642d00f0fec7","createdAt":"2016-04-21T14:16:04.978Z","project":"56439dfe9eebf70d00490d54","__v":0},"user":"5d411a29005b9600113731fd","createdAt":"2019-08-01T07:18:06.717Z","__v":3,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

username:
string
Username to search
email:
string
Email to search
userids:
array of strings
Comma separated list of userids. Max 50 User Ids supported

Result Format


Documentation

[block:parameters] { "data": { "h-0": "Header Name", "h-1": "Value", "0-0": "Authorization", "0-1": "Token{TOKEN}" }, "cols": 2, "rows": 1 } [/block]

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