Get Records API Samples | Online Help - Zoho CRM

Get Records API Samples | Online Help - Zoho CRM

Get Records - Examples

The examples used in this section use REST API resources to retrieve, insert, update, and delete records, along with other record-related operations.

Get Records from page 1 of the Leads module

Purpose

To get the list of records from page 1 of the Leads module.

Request URL

https://www.zohoapis.com/crm/v2/{module_api_name}

module_api_name - The api name of the module.

Scope

scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

Possible module names Possible operation types
leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, custom, notes, approvals, dashboards, search and activities. ALL - Full access to record
READ - get records from a module

Request Method

GET

Parameters

Parameter Name Data Type Description Possible Values
fields (optional) String To list all the module records with respect to fields Multiple field API names, comma separated. For example: Last_Name,Email
sort_order (optional) String To sort the available list of records in either ascending or descending order asc - ascending order
desc - descending order
sort_by (optional) String To sort the available list of records based on given field Field API name
Example: Email
converted (optional) String To get the list of converted records 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 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. Positive Integer values only
per_page (optional) Integer To get the list of records available per page. Default value for per page is 200. Positive Integer values only
cvid (optional) Integer To get the list of records based on custom views {custom_view_id}
Curl

Sample Request:

curl "https://www.zohoapis.com/crm/v2/Leads?page=1&per_page=2"

-X GET

-H "Authorization: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52

Copy sample code

Sample Response:

    • Related Articles

    • Using API Key - Serverless Functions

      Introduction A severless function within your CRM can be invoked from any third-party application or within the CRM using a webhook. However, generally most of the webhooks do not support OAuth2, save for a few of them. In that case, you can execute ...

    • Update Records API Samples | Online Help - Zoho CRM

      Update Records - Examples Update Leads Sample Request: curl "https://www.zohoapis.com/crm/v2/Leads" -X PUT -d "updatelead.json" -H "-H "Authorization: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52" Note: In the above request, @updatelead.json ...

    • Insert Records API Samples | Online Help - Zoho CRM

      Insert Records - Examples Insert Subforms Purpose To insert a new record with subforms in a module Request URL https://www.zohoapis.com/crm/v2/Leads Request Method POST Sample Request: curl "https://www.zohoapis.com/crm/v2/Leads" -H "Authorization: ...

    • Users API Samples | Online Help - Zoho CRM

      Users APIs - Examples Use the Users APIs, to retrieve the basic information of your available CRM users. Get All users Purpose To retrieve the list of all users in your CRM Account. Request URL https://www.zohoapis.com/crm/v2/users?type=AllUsers ...

    • API Guide for Developers | Online Help - Zoho CRM

      Introduction Zoho CRM provides REST API (Application Programming Interface) that lets you integrate CRM with third-party applications such as, accounting, ERP, ecommerce, self-service portals and others. The REST API uses simple HTTP methods, such as ...