/search GET

Overview

List records in a module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times.

Request Arguments

Name	Type	Description	Required
q	String	The search text to match records on. This will search through any fields on the module that has unified_search set to true.	False
max_num	Integer	A maximum number of records to return.	False
offset	Integer	The number of records to skip over before records are returned.	False
fields	String	Comma delimited list of fields to return. The field date_modified will always be returned. Example: `name,account_type,description`	False
order_by	String	How to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon. Example: `name:DESC,account_type:DESC,date_modified:ASC`	False
favorites	Boolean	Only fetch the current users favorited records.	False
my_items	Boolean	Only fetch items assigned to the current user.	False

Response Arguments

Name	Type	Description
next_offset	Integer	Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records.
records	Array	An array of results containing matched records.

Response

{
   "next_offset":2,
   "records":[
      {
         "id":"ecbf2a6c-261e-5fca-fbb6-512d093554b8",
         "name":"Avery Software Co",
         "date_modified":"2013-02-26T19:12:56+00:00",
         "description":"",
         "my_favorite":false,
         "_acl":{
            "fields":{

            }
         },
         "_module":"Accounts",
         "_search":{
            "score":1
         }
      },
      {
         "id":"af5f8dae-7169-b497-1d77-512d0937ed81",
         "name":"Avery Software Co",
         "date_modified":"2013-02-26T19:12:56+00:00",
         "description":"",
         "my_favorite":false,
         "_acl":{
            "fields":{

            }
         },
         "_module":"Accounts",
         "_search":{
            "score":1
         }
      }
   ]
}

Change Log

Version	Change
v10	Added `/<module>` GET endpoint.