Search Records

Purpose

To retrieve the records that match your search criteria.

Request URL

https://workerly.zoho.com/workerly/v2/{module_api_name}/search

module_api_name - The API name of the module

Supported modules

Temps, Jobs, Clients, Timesheets, Contacts, To-Dos
note: Additionally, the API supports activated marketplace extensions.

Request Method

GET

Scope

scope=ZohoWorkerly.modules.all
(or)
scope=ZohoWorkerly.modules.{module_name}.{operation_type}
(and) note: Additionally, the API supports activated marketplace extensions.
scope=ZohoSearch.securesearch.READ

Possible module names

Possible operation types

Temps, Jobs, Clients, Timesheets, Contacts, To-Dos
note: Additionally, the API supports activated marketplace extensions.

ALL - Full access to the record
READ - Get records from the module

Parameters

Parameter Name	Data Type	Description
criteria	String	Performs search by following the shown criteria. (({api_name}:{starts_with\|equals}:{value})and/or({api_name}:{starts_with\|equals}:{value})) You can search for a maximum of 10 criteria (with same or different columns) with equals and starts_with conditions. When you use parentheses or comma in the value for a criteria, you must escape them using a backslash. Further, you must encode the value. Example: Consider the search term: ((Last_Name:equals:Burns,B)and(First_Name:starts_with:M)) After escaping comma and parenthesis in the value: ((Last_Name:equals:Burns\,B)and(First_Name:starts_with:M)) After encoding the value: ((Last_Name:equals:Burns%5C%2CB)and(First_Name:starts_with:M)) To search for Date, DateTime, Lookup, Number, Currency, Boolean fields, you need comparators other than starts_with and equals.
email	String	Performs module search by email. All the email fields of a particular module will be searched and listed.
phone	String	Performs module search by phone number. All the phone fields of a particular module will be searched and listed.
word	String	Performs global search by word.
converted (optional)	String	To get the list of converted records. Default value is false. true - get only converted records false - get only non-converted records both - get all records
approved (optional)	String	To get the list of approved records. Default value is true. true - get only approved records false - get only records which are not approved both - get all records
page (optional)	Integer	To get the list of records from the respective pages. Default value for page is 1.
per_page (optional)	Integer	To get the list of records available per page. Default value for page is 200.

Note:

Only one of the above four parameters would work at one point of time. Furthermore, if two parameters are given simultaneously, preference will be given in the order criteria, email, phone, and word, and only one of them would work.
The page and per_page parameter is used to fetch records according to their position in Workerly. Let's assume that the user has to fetch 400 records. The maximum number of records that one can get for an API call is 200. So, for records above the 200th position, they cannot be fetched. By changing the values of the page (1, 2) and per_page (200) parameters, the user can fetch all 400 records using 2 API calls.

Sample Request

Copiedhttps://workerly.zoho.com/workerly/v2/Temps/search?criteria=(Last_Name:contains:burrows)

Sample Response

Copied{
    "data": [
        {
            "Kiosk_Key": 1005,
            "Email": "amelia.burrows200@gmail.com",
            "Mobile_Country_Code": "IN",
            "$currency_symbol": "₹",
            "Source": "Internal",
            "Last_Activity_Time": "2020-08-18T15:35:21+05:30",
            "First_Name": "ghfg",
            "Full_Name": "Amelia Burrows",
            "Skill_Set": [
                "ard,raj"
            ],
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "15304000000047007"
            },
            "Phone": null,
            "Updated_On": "2020-08-17T15:23:00+05:30",
            "Street": null,
            "Current_Title": "Nurse",
            "Zip_Code": null,
            "id": "15304000000054555",
            "Base_Pay_Rate_Per_Hour": 0,
            "Email_Opt_Out": false,
            "$approved": true,
            "Temp_ID": "TW-5",
            "Last_Mailed_Time": null,
            "Created_Time": "2020-08-17T15:23:00+05:30",
            "Temp_Owner": {
                "name": "Patricia Boyle",
                "id": "15304000000047007"
            },
            "$editable": true,
            "City": null,
            "Mobile": "9655335492",
            "Associated_Tags": [],
            "Temp_Status": "Active",
            "Experience": null,
            "Last_Name": "Burrows",
            "State": null,
            "Country": null,
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "15304000000047007"
            },
            "Is_Attachment_Present": false,
            "LEADPORTALSTATUS": "0"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}