Smart Search

get
Search Users

https://api.playportal.io/user/v1/search
Searches for other users of your app that have public search turned on.
Request
Response
Request
Headers
Authorization
required
string
Authentication token generated by logging in.
Query Parameters
term
required
string
What to search for. The API will search for all users with a similar handle or full name (first name and last name together).
page
optional
number
Results page to return. This can be combined with the "limit" parameter to paginate results.
limit
optional
number
How many results to return per page.
Response
200: OK
Cake successfully retrieved.
{ docs:
[ { handle: '@testkid-testerson1',
firstName: 'Vivian',
lastName: 'Testerson',
userType: 'child',
accountType: 'Kid',
country: 'US',
profilePic: '5c53339162a6a46da9020375',
coverPhoto: '5c53339262a6a46da9020376',
userId: '8160b11248203275949e26d938f0fbb3f8d556603dd17254b4ee4c9ad0cec9f1c35530f9e7dad78751cab1f82172c097fffab1969f50b91cff6167de462d086fc3baebfc54c79ab1fd0c9faad7ca7e9db7$ac797ac23134d63e65162b0da86379bc',
anonymous: false,
parentFlags: [Object] },
{ handle: '@testkid-testerson4',
firstName: 'Olivia',
lastName: 'Testerson',
userType: 'child',
accountType: 'Kid',
country: 'US',
profilePic: '5c53339162a6a46da9020375',
coverPhoto: '5c53339262a6a46da9020376',
userId: '8160b11248203275949e26d938f0fbb3f8d556603dd1720eb4ee4c9ad0cec9f1c35530f9e7dad78751cab1f82172c097fffab1969f50b91cff6167de462d086fc3baebfc54c79ab1fd0c9faad7ca7e9db7$ac797ac23134d63e65162b0da86379bc',
anonymous: false,
parentFlags: [Object] },
{ handle: '@testkid-testerson2',
firstName: 'Penny',
lastName: 'Testerson',
userType: 'child',
accountType: 'Kid',
country: 'US',
profilePic: '5c53339162a6a46da9020375',
coverPhoto: '5c53339262a6a46da9020376',
userId: '8160b11248203275949e26d938f0fbb3f8d556603dd17255b4ee4c9ad0cec9f1c35530f9e7dad78751cab1f82172c097fffab1969f50b91cff6167de462d086fc3baebfc54c79ab1fd0c9faad7ca7e9db7$ac797ac23134d63e65162b0da86379bc',
anonymous: false,
parentFlags: [Object] },
{ handle: '@testmom-testerby',
firstName: 'Nancy',
lastName: 'Testerby',
userType: 'adult',
accountType: 'Parent',
country: 'US',
profilePic: '5c53339362a6a46da9020397',
coverPhoto: '5c53339362a6a46da9020398',
userId: '8160b11248203275949e26d938f0fbb3f8d556603dd17c55b4ee4c9ad0cec9f1c35530f9e7dad78751cab1f82172c097fffab1969f50b91cff6167de462d086fc3baebfc54c79ab1fd0c9faad7ca7e9db7$ac797ac23134d63e65162b0da86379bc',
anonymous: false } ],
page: 1,
total: 4 }

get
Sample Users

https://api.playportal.io/user/v1/search/random
Retrieves a number of random users of your app who have public search turned on.
Request
Response
Request
Headers
Authorization
required
string
Authentication token generated by logging in.
Query Parameters
count
required
number
How many users to search for. Max of 25.
Response
200: OK
[ { handle: '@testkid-testerson3',
firstName: 'Hannah',
lastName: 'Testerson',
userType: 'child',
accountType: 'Kid',
country: 'US',
profilePic: '5c5333cc70f6ec6db2c73ec4',
coverPhoto: '5c5333cc70f6ec6db2c73ec5',
userId: '7703db56dd6f474491a31cd4a6d2f983b5d2be4eb40cb99c6bdf45185a5f6680615363f354583dd3caddaed8e778b1551459e324a8f676092944c2294f6618d68c7de38920781ae6bf12867f4d318bd6b3$fc7cea2e63fb2eca959225a2f7600965',
anonymous: false,
parentFlags: { cameraDisabled: false, proximityFriends: false } },
{ handle: '@testkid-testerson4',
firstName: 'Rachel',
lastName: 'Testerson',
userType: 'child',
accountType: 'Kid',
country: 'US',
profilePic: '5c5333cc70f6ec6db2c73ec4',
coverPhoto: '5c5333cc70f6ec6db2c73ec5',
userId: '7703db56dd6f474491a31cd4a6d2f983b5d2be4eb40cb9c46bdf45185a5f6680615363f354583dd3caddaed8e778b1551459e324a8f676092944c2294f6618d68c7de38920781ae6bf12867f4d318bd6b3$fc7cea2e63fb2eca959225a2f7600965',
anonymous: false,
parentFlags: { cameraDisabled: false, proximityFriends: false } },
{ handle: '@testmom-testerby',
firstName: 'Vivian',
lastName: 'Testerby',
userType: 'adult',
accountType: 'Parent',
country: 'US',
profilePic: '5c5333cc70f6ec6db2c73ee6',
coverPhoto: '5c5333cc70f6ec6db2c73ee7',
userId: '7703db56dd6f474491a31cd4a6d2f983b5d2be4eb40cbf9d6bdf45185a5f6680615363f354583dd3caddaed8e778b1551459e324a8f676092944c2294f6618d68c7de38920781ae6bf12867f4d318bd6b3$fc7cea2e63fb2eca959225a2f7600965',
anonymous: false },
{ handle: '@testkid-testerson2',
firstName: 'Penny',
lastName: 'Testerson',
userType: 'child',
accountType: 'Kid',
country: 'US',
profilePic: '5c5333cc70f6ec6db2c73ec4',
coverPhoto: '5c5333cc70f6ec6db2c73ec5',
userId: '7703db56dd6f474491a31cd4a6d2f983b5d2be4eb40cb99d6bdf45185a5f6680615363f354583dd3caddaed8e778b1551459e324a8f676092944c2294f6618d68c7de38920781ae6bf12867f4d318bd6b3$fc7cea2e63fb2eca959225a2f7600965',
anonymous: false,
parentFlags: { cameraDisabled: false, proximityFriends: false } } ]