Developer Center

Objects Search API

Last Updated: Feb 20, 2017 04:13PM CET

URL

/api/search

Description

Search for different objects based on keywords

Methods

GET

Search for different object types using keywords. The search can also include an optional list of object types to search for using a 'type' parameter.

Parameters

query The keyword to search for.Required
type Type of object to search for. The search can contain multiple types as a list. Available types:
  • CLIENT
  • GROUP
  • LOAN_ACCOUNT
  • SAVINGS_ACCOUNT
  • USER
  • BRANCH
  • CENTRE

Search fields

The search can be done by using as keywords one of the following fields for each object type:
 
CLIENT first name, middle name, last name, id
GROUP group name, id
LOAN_ACCOUNT account id
SAVINGS_ACCOUNT account id
USER first name, last name, username
BRANCH branch name, branch id
CENTRE centre name, centre id

Usage examples

//search through all object types for the object that might contain john
GET /api/search?query=john

//search CLIENT and USER types for the object that might contain john. The result will contain the first 10 results
GET /api/search?query=john&type=[CLIENT,USER]&limit=10

Samples responses:

//sample response of search by keyword john for type=[CLIENT,USER]
{
   "CLIENT":[
      {
         "resultType":"CLIENT",
         "displayText":"John Demo",
         "resultID":"517706810",
         "resultKey":"8a42711a4428c1f101442a1bbcbc0009"
      },
      {
         "resultType":"CLIENT",
         "displayText":"John Master",
         "resultID":"603117506",
         "resultKey":"8a42711a4428c1f101442a1ee710001b"
      }
   ],
   "USER":[
      {
         "resultType":"USER",
         "displayText":"John Doe",
         "resultID":"61",
         "resultKey":"8a54e5b44449337f01444b03efa3000e"
      }
   ]
}
support@mambu.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete