Search records

Retrieve the records that match the specified criteria, email, phone, or word.

Request URL

{api-domain}/bigin/v2/{module_api_name}/search

Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

For US, https://www.zohoapis.com
For EU, https://www.zohoapis.eu
For AU, https://www.zohoapis.com.au
For IN, https://www.zohoapis.in
For CN, https://www.zohoapis.com.cn
For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

Authorization

For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with one of the following scopes:

ZohoBigin.modules.{module_name}.ALL and ZohoSearch.securesearch.READ
ZohoBigin.modules.{module_name}.READ and ZohoSearch.securesearch.READ

In the above scope, replace {module_name} with the module for which you want to retrieve the records. The possible modules include pipelines, contacts, accounts (companies in Bigin), products, calls, events, and tasks.

Request parameters

The available request parameters are given below:

Path parameters

module_api_name stringRequired

The API name of the module. The possible modules for this endpoint and their API name are given below:

Module	API Name
Contacts	Contacts
Pipelines	Pipelines
Companies	Accounts
Products	Products
Tasks	Tasks
Events	Events
Calls	Calls
Notes	Notes

Query parameters

You must include query parameters with the request URL to filter, search, and retrieve records from a module.

Endpoints

GET /{module_api_name}/search?criteria={criteria_here}

GET /{module_api_name}/search?email={email_here}

GET /{module_api_name}/search?phone={phone_number_here}

GET /{module_api_name}/search?word={search_word_here}

Search records using criteria

criteria stringRequired

Provide the criteria for your search to filter and get the records you need. The criteria represents the specific conditions that the records must meet in order to be fetched in the response.

The criteria must be provided as shown below:

criteria = (({field_api_name}:{comparator}:{value})AND/OR({field_api_name}:{comparator}:{value}))

The {field_api_name} can be fetched from the Get Field Metadata API.

Data Types	Supported Comparators
text, email, website, autonumber, picklist, lookup, ownerlookup, userlookup, phone	equals, not_equal, starts_with, in
datetime, date, integer, long_str, currency, double_str, decimal, bigint, percent	equals, not_equal, greater_than, greater_equal, less_than, less_equal, between, in
boolean_str	equals, not_equal, in

Sample request 1 - criteria

Curl Deluge

Copiedcurl "https://www.zohoapis.com/bigin/v2/Pipelines/search?criteria=((Deal_Name:starts_with:W)and(Amount:greater_than:5000))" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Pipelines/search?criteria=((Deal_Name:starts_with:W)and(Amount:greater_than:5000))"
	type: GET
	connection:"connection_link_name"
];
info response;

Sample request 2 - criteria

Curl Deluge

Copiedcurl "https://www.zohoapis.com/bigin/v2/Contacts/search?criteria=(Created_Time:greater_than:2019-07-15T20:10:40%2b05:30)" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/search?criteria=(Created_Time:greater_than:2019-07-15T20:10:40%2b05:30)"
	type: GET
	connection:"connection_link_name"
];
info response;

Sample response

Json Deluge

Copied{
    "data": [
        {
            "Owner": {
                "name": "Sarah Johnson",
                "id": "2034020000000474061",
                "email": "aravind.vavilala+sarahjohnson@zohotest.com"
            },
            "Email": "sophia.brooks@example.com",
            "Description": "A green and orange striped umbrella.",
            "$currency_symbol": "$",
            "Mailing_Zip": "92101",
            "$field_states": null,
            "Mailing_State": "CA",
            "Mailing_Street": "135 Walnut Dr.",
            "$followers": null,
            "$sharing_permission": "full_access",
            "Last_Activity_Time": "2023-05-26T12:29:51+05:30",
            "First_Name": "Sophia",
            "Full_Name": "Sophia Brooks",
            "Record_Image": null,
            "Modified_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "aravind.vavilala+travel_agency@zohotest.com"
            },
            "Unsubscribed_Mode": null,
            "Phone": null,
            "Mailing_Country": "Spain",
            "Account_Name": {
                "name": "Apex Enterprises",
                "id": "2034020000000478021"
            },
            "id": "2034020000000489022",
            "Email_Opt_Out": false,
            "$zia_visions": null,
            "Modified_Time": "2023-05-26T12:29:51+05:30",
            "Mailing_City": "San Diego",
            "Created_Time": "2023-04-20T17:13:47+05:30",
            "Unsubscribed_Time": null,
            "$followed": false,
            "Title": null,
            "$editable": true,
            "Mobile": "609-961-5520",
            "Home_Phone": null,
            "Last_Name": "Brooks",
            "Tag": [],
            "Created_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "aravind.vavilala+travel_agency@zohotest.com"
            },
            "$zia_owner_assignment": "owner_recommendation_unavailable",
            "$approval_state": "approved"
        }
    ]
}

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/search?criteria=(Created_Time:greater_than:2019-07-15T20:10:40%2b05:30)"
	type: GET
	connection:"connection_link_name"
];
info response;

Search records using email address

email stringRequired

Provide the email address for your search to filter and get the records within a specified module. It will search through all the email fields associated with that module.

Sample request - Email

Curl Deluge

Copiedcurl "https://www.zohoapis.com/bigin/v2/Contacts/search?email=newcrmapi@zoho.com" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/search?email=newcrmapi@zoho.com"
	type: GET
	connection:"connection_link_name"
];
info response;

Sample response

Json Deluge

Copied{
    "data": [
        {
            "Account": null,
            "Owner": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "Company": null,
            "Email": "newcrmapi@zoho.com",
            "$currency_symbol": "Rs.",
            "Last_Activity_Time": "2019-03-22T11:10:55+05:30",
            "Mailing_Street": "Street",
            "Mailing_Zip": "Zip_Code",
            "id": "3652397000000415002",
            "$approved": true,
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false,
                "resubmit": false
            },
            "Created_Time": "2019-01-10T13:04:32+05:30",
            "$editable": true,
            "Mailing_City": "City",
            "Mailing_State": "State",
            "Mailing_Country": "Country",
            "Last_Visited_Time": null,
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "Email": "newcrmapi@zoho.com",
            "Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
            "Salutation": "Mr.",
            "First_Name": "First_Name",
            "Full_Name": "Mr. First_Name Last_Name",
            "Record_Image": null,
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "Phone": "98883434559",
            "Email_Opt_Out": false,
            "Modified_Time": "2019-03-22T11:10:55+05:30",
            "Mobile": "98883434559",
            "Last_Name": "Last_Name",
            "Tag": []
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/search?email=newcrmapi@zoho.com"
	type: GET
	connection:"connection_link_name"
];
info response;

Sample response

Json Deluge

Copied{
    "data": [
        {
            "Owner": {
                "name": "Sarah Johnson",
                "id": "2034020000000474061",
                "email": "aravind.vavilala+sarahjohnson@zohotest.com"
            },
            "Email": "sophia.brooks@example.com",
            "Description": "A green and orange striped umbrella.",
            "$currency_symbol": "$",
            "Mailing_Zip": "92101",
            "$field_states": null,
            "Mailing_State": "CA",
            "Mailing_Street": "135 Walnut Dr.",
            "$followers": null,
            "$sharing_permission": "full_access",
            "Last_Activity_Time": "2023-05-26T12:29:51+05:30",
            "First_Name": "Sophia",
            "Full_Name": "Sophia Brooks",
            "Record_Image": null,
            "Modified_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "aravind.vavilala+travel_agency@zohotest.com"
            },
            "Unsubscribed_Mode": null,
            "Phone": null,
            "Mailing_Country": "Spain",
            "Account_Name": {
                "name": "Apex Enterprises",
                "id": "2034020000000478021"
            },
            "id": "2034020000000489022",
            "Email_Opt_Out": false,
            "$zia_visions": null,
            "Modified_Time": "2023-05-26T12:29:51+05:30",
            "Mailing_City": "San Diego",
            "Created_Time": "2023-04-20T17:13:47+05:30",
            "Unsubscribed_Time": null,
            "$followed": false,
            "Title": null,
            "$editable": true,
            "Mobile": "609-961-5520",
            "Home_Phone": null,
            "Last_Name": "Brooks",
            "Tag": [],
            "Created_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "aravind.vavilala+travel_agency@zohotest.com"
            },
            "$zia_owner_assignment": "owner_recommendation_unavailable",
            "$approval_state": "approved"
        }
    ]
}

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/search?criteria=(Created_Time:greater_than:2019-07-15T20:10:40%2b05:30)"
	type: GET
	connection:"connection_link_name"
];
info response;

Search records using phone number

phone stringRequired

Provide the phone number for your search to filter and get the records within a specified module. It will search through all the phone number fields associated with that module.

Sample request - Phone Number

Curl Deluge

Copiedcurl "https://www.zohoapis.com/bigin/v2/Contacts/search?phone=98883434559" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/search?phone=98883434559"
	type: GET
	connection:"connection_link_name"
];
info response;

Sample response

Json Deluge

Copied{
    "data": [
        {
            "Account": null,
            "Owner": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "Company": null,
            "Email": "newcrmapi@zoho.com",
            "Last_Activity_Time": "2019-03-22T11:10:55+05:30",
            "Mailing_Street": "Street",
            "Mailing_Zip": "Zip_Code",
            "id": "3652397000000415002",
            "$approved": true,
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false,
                "resubmit": false
            },
            "Created_Time": "2019-01-10T13:04:32+05:30",
            "$editable": true,
            "Mailing_City": "City",
            "Mailing_State": "State",
            "Mailing_Country": "Country",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "Email": "newcrmapi@zoho.com",
            "Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
            "Salutation": "Mr.",
            "First_Name": "First_Name",
            "Full_Name": "Mr. First_Name Last_Name",
            "Record_Image": null,
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "Skype_ID": "Skype_ID",
            "Phone": "98883434559",
            "Email_Opt_Out": false,
            "Modified_Time": "2019-03-22T11:10:55+05:30",
            "Mobile": "98883434559",
            "Last_Name": "Last_Name",
            "Tag": [],
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/search?phone=98883434559"
	type: GET
	connection:"connection_link_name"
];
info response;

Sample response

Json Deluge

Copied{
    "data": [
        {
            "Owner": {
                "name": "Sarah Johnson",
                "id": "2034020000000474061",
                "email": "aravind.vavilala+sarahjohnson@zohotest.com"
            },
            "Email": "sophia.brooks@example.com",
            "Description": "A green and orange striped umbrella.",
            "$currency_symbol": "$",
            "Mailing_Zip": "92101",
            "$field_states": null,
            "Mailing_State": "CA",
            "Mailing_Street": "135 Walnut Dr.",
            "$followers": null,
            "$sharing_permission": "full_access",
            "Last_Activity_Time": "2023-05-26T12:29:51+05:30",
            "First_Name": "Sophia",
            "Full_Name": "Sophia Brooks",
            "Record_Image": null,
            "Modified_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "aravind.vavilala+travel_agency@zohotest.com"
            },
            "Unsubscribed_Mode": null,
            "Phone": null,
            "Mailing_Country": "Spain",
            "Account_Name": {
                "name": "Apex Enterprises",
                "id": "2034020000000478021"
            },
            "id": "2034020000000489022",
            "Email_Opt_Out": false,
            "$zia_visions": null,
            "Modified_Time": "2023-05-26T12:29:51+05:30",
            "Mailing_City": "San Diego",
            "Created_Time": "2023-04-20T17:13:47+05:30",
            "Unsubscribed_Time": null,
            "$followed": false,
            "Title": null,
            "$editable": true,
            "Mobile": "609-961-5520",
            "Home_Phone": null,
            "Last_Name": "Brooks",
            "Tag": [],
            "Created_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "aravind.vavilala+travel_agency@zohotest.com"
            },
            "$zia_owner_assignment": "owner_recommendation_unavailable",
            "$approval_state": "approved"
        }
    ]
}

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/search?criteria=(Created_Time:greater_than:2019-07-15T20:10:40%2b05:30)"
	type: GET
	connection:"connection_link_name"
];
info response;

Search records using a word

word stringRequired

Provide a word for your search to filter and get the records within a specified module. It searches for the word across all available sources or modules.

Response object

The response object contains a list of records that are filtered based on the specified query parameter.

Possible error codes

The response of this resource includes HTTP status and error codes.

The most common HTTP error codes that occur when you request access to this endpoint are given in the following:

Sample request - word

Curl Deluge

Copiedcurl "https://www.zohoapis.com/bigin/v2/Contacts/search?word=abc" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" \

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/search?word=abc"
	type: GET
	connection:"connection_link_name"
];
info response;

Sample response

Json Deluge

Copied{
    "data": [
        {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "Company": "Company1",
            "Email": null,
            "Last_Activity_Time": null,
            "Mailing_Street": null,
            "Mailing_Zip": null,
            "id": "3652397000000562046",
            "$approved": true,
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false,
                "resubmit": false
            },
            "Created_Time": "2019-02-19T12:57:55+05:30",
            "$editable": true,
            "Mailing_City": null,
            "Mailing_State": null,
            "Mailing_Country": null,
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "Description": null,
            "Salutation": null,
            "First_Name": null,
            "Lead_Status": null,
            "Full_Name": "abc",
            "Record_Image": null,
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "Skype_ID": null,
            "Phone": null,
            "Email_Opt_Out": false,
            "Modified_Time": "2019-02-19T12:57:55+05:30",
            "Mobile": null,
            "First_Visited_Time": null,
            "Last_Name": "abc",
            "Tag": [],
            "Fax": null
        },
        {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "Company": "abc",
            "Email": null,
            "Last_Activity_Time": "2019-02-19T12:06:28+05:30",
            "Industry": "ERP (Enterprise Resource Planning)",
            "$converted": false,
            "$process_flow": false,
            "Street": null,
            "Zip_Code": null,
            "id": "3652397000000538029",
            "$approved": true,
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false,
                "resubmit": false
            },
            "Created_Time": "2019-02-14T18:19:22+05:30",
            "$editable": true,
            "Mailing_City": "Albany",
            "Mailing_State": null,
            "Mailing_Country": null,
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "Description": null,
            "Salutation": null,
            "First_Name": "Test1",
            "Lead_Status": "Contacted",
            "Full_Name": "Test1 Contact1",
            "Record_Image": null,
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "Phone": null,
            "Email_Opt_Out": true,
            "Modified_Time": "2019-02-19T12:06:28+05:30",
            "Mobile": null,
            "Last_Name": "Contact1",
            "Tag": []
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/search?word=abc"
	type: GET
	connection:"connection_link_name"
];
info response;

Sample response

Json Deluge

Copied{
    "data": [
        {
            "Owner": {
                "name": "Sarah Johnson",
                "id": "2034020000000474061",
                "email": "aravind.vavilala+sarahjohnson@zohotest.com"
            },
            "Email": "sophia.brooks@example.com",
            "Description": "A green and orange striped umbrella.",
            "$currency_symbol": "$",
            "Mailing_Zip": "92101",
            "$field_states": null,
            "Mailing_State": "CA",
            "Mailing_Street": "135 Walnut Dr.",
            "$followers": null,
            "$sharing_permission": "full_access",
            "Last_Activity_Time": "2023-05-26T12:29:51+05:30",
            "First_Name": "Sophia",
            "Full_Name": "Sophia Brooks",
            "Record_Image": null,
            "Modified_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "aravind.vavilala+travel_agency@zohotest.com"
            },
            "Unsubscribed_Mode": null,
            "Phone": null,
            "Mailing_Country": "Spain",
            "Account_Name": {
                "name": "Apex Enterprises",
                "id": "2034020000000478021"
            },
            "id": "2034020000000489022",
            "Email_Opt_Out": false,
            "$zia_visions": null,
            "Modified_Time": "2023-05-26T12:29:51+05:30",
            "Mailing_City": "San Diego",
            "Created_Time": "2023-04-20T17:13:47+05:30",
            "Unsubscribed_Time": null,
            "$followed": false,
            "Title": null,
            "$editable": true,
            "Mobile": "609-961-5520",
            "Home_Phone": null,
            "Last_Name": "Brooks",
            "Tag": [],
            "Created_By": {
                "name": "Zylker Travels",
                "id": "2034020000000457001",
                "email": "aravind.vavilala+travel_agency@zohotest.com"
            },
            "$zia_owner_assignment": "owner_recommendation_unavailable",
            "$approval_state": "approved"
        }
    ]
}

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/search?criteria=(Created_Time:greater_than:2019-07-15T20:10:40%2b05:30)"
	type: GET
	connection:"connection_link_name"
];
info response;