Smart Search

Reminder: if you are using an app/client ID in sandbox, you must use sandbox.motar.io as the endpoint for your requests. Requests to api.motar.io with a sandbox client ID will fail!

Search Users

GET https://api.motar.io/user/v1/search

Searches for other users of your app that have public search turned on.

Query Parameters

Name	Type	Description
limit	number	How many results to return per page.
page	number	Results page to return. This can be combined with the "limit" parameter to paginate results.
term	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).

Headers

Name	Type	Description
Authorization	string	Authentication token generated by logging in.

200 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] 
       "militaryGrade": "E-2",
       "displayRank": "Airman",
       "displayDutyTitle": "Command Post Controller" },
     { handle: '@testkid-testerson4',
       firstName: 'Olivia',
       lastName: 'Testerson',
       userType: 'child',
       accountType: 'Kid',
       country: 'US',
       profilePic: '5c53339162a6a46da9020375',
       coverPhoto: '5c53339262a6a46da9020376',
       userId: '8160b11248203275949e26d938f0fbb3f8d556603dd1720eb4ee4c9ad0cec9f1c35530f9e7dad78751cab1f82172c097fffab1969f50b91cff6167de462d086fc3baebfc54c79ab1fd0c9faad7ca7e9db7$ac797ac23134d63e65162b0da86379bc',
       anonymous: false,
       parentFlags: [Object] 
       "civilianGrade": "GS",
       "civilianBand": "6",
       "jobSeriesNumber": "1550",
       "jobTitle": "Computer Science" },
     { handle: '@testkid-testerson2',
       firstName: 'Penny',
       lastName: 'Testerson',
       userType: 'child',
       accountType: 'Kid',
       country: 'US',
       profilePic: '5c53339162a6a46da9020375',
       coverPhoto: '5c53339262a6a46da9020376',
       userId: '8160b11248203275949e26d938f0fbb3f8d556603dd17255b4ee4c9ad0cec9f1c35530f9e7dad78751cab1f82172c097fffab1969f50b91cff6167de462d086fc3baebfc54c79ab1fd0c9faad7ca7e9db7$ac797ac23134d63e65162b0da86379bc',
       anonymous: false,
       parentFlags: [Object] 
       "militaryGrade": "E-2",
       "displayRank": "Airman",
       "displayDutyTitle": "Command Post Controller" },
     { handle: '@testmom-testerby',
       firstName: 'Nancy',
       lastName: 'Testerby',
       userType: 'adult',
       accountType: 'Parent',
       country: 'US',
       profilePic: '5c53339362a6a46da9020397',
       coverPhoto: '5c53339362a6a46da9020398',
       userId: '8160b11248203275949e26d938f0fbb3f8d556603dd17c55b4ee4c9ad0cec9f1c35530f9e7dad78751cab1f82172c097fffab1969f50b91cff6167de462d086fc3baebfc54c79ab1fd0c9faad7ca7e9db7$ac797ac23134d63e65162b0da86379bc',
       anonymous: false,
       "civilianGrade": "GS",
       "civilianBand": "6",
       "jobSeriesNumber": "1550",
       "jobTitle": "Computer Science"
     }
  ],
  page: 1,
  total: 4 }

Sample Users

GET https://api.motar.io/user/v1/search/random

Retrieves a number of random users of your app who have public search turned on.

Query Parameters

Name	Type	Description
count	number	How many users to search for. Max of 25

Headers

Name	Type	Description
Authorization	string	Authentication token generated by logging in.

200

[ { 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 } 
    "militaryGrade": "E-2",
    "displayRank": "Airman",
    "displayDutyTitle": "Command Post Controller" },
  { 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 },
    "civilianGrade": "GS",
    "civilianBand": "6",
    "jobSeriesNumber": "1550",
    "jobTitle": "Computer Science" },
  { handle: '@testmom-testerby',
    firstName: 'Vivian',
    lastName: 'Testerby',
    userType: 'adult',
    accountType: 'Parent',
    country: 'US',
    profilePic: '5c5333cc70f6ec6db2c73ee6',
    coverPhoto: '5c5333cc70f6ec6db2c73ee7',
    userId: '7703db56dd6f474491a31cd4a6d2f983b5d2be4eb40cbf9d6bdf45185a5f6680615363f354583dd3caddaed8e778b1551459e324a8f676092944c2294f6618d68c7de38920781ae6bf12867f4d318bd6b3$fc7cea2e63fb2eca959225a2f7600965',
    anonymous: false,
    "militaryGrade": "E-2",
    "displayRank": "Airman",
    "displayDutyTitle": "Command Post Controller" },
  { 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 },
    "civilianGrade": "GS",
    "civilianBand": "6",
    "jobSeriesNumber": "1550",
    "jobTitle": "Computer Science" } ]