Kaizen#42 - Parameters in all GET Requests #API

Kaizen#42 - Parameters in all GET Requests #API

Hello everyone!
Welcome back to another post in the Kaizen series!
Today, we will discuss all the parameters available in all GET requests.

What is a parameter in a request URL?
A parameter or param is a name/key-value pair that is included in the request URL and it forms the query string.
Consider this example: https://www.myexample.com?id=123
Here, the request URL is https://www.myexample.com, while the parameter is id whose value is 123.
You can also have multiple parameters separated by an ampersand (&) in a request URL like https://www.myexample.com?id=123&name=Boyle

Therefore, the data after the question mark (?) contain the parameters that form the query string, and help to narrow down your response.

Now, let us see the various parameters used in the GET requests of the Zoho CRM APIs.

Parameter and Type
Description
Values
Used in
module
string
The API name of the module you want to fetch the records or details from.
--
fields
string
The API names of the fields whose details you want to receive in the response.
--
sort_by
string
The API name of the field based on which you want to sort the response.
By default, the records are sorted by their IDs in ascending order.
sort_order
string
The order in which you want to receive the response.
asc - to sort the response in ascending order. This is the default value.
desc - to sort the response in descending order.
converted
string
To get the list of converted records.
true - to get the converted records
false - to get only non-converted records
both - to get both converted and non-converted records.
The default value is false.
approved
string
To get the list of approved records.
true - to get only approved records
false - to get only unapproved records
both - to get all approved and unapproved records.
The default value is true
page
integer
To get the list of records from the respective pages.
Positive integer values only. The default value is 1.
per_page
integer
The number of records you want to fetch per API call.
Positive integer values only. The default value is 200.
cvid
string
The custom view's ID you want to fetch the records from.
--
territory_id
string
The ID of the territory you want to fetch the records from.
--
include_child
boolean
To get the records from the child territories, if any.
true - to get the records from child territories
false - to get records only from the parent territory.
The default value is false.
type
string
The type of deleted records you want to fetch.
All - To get the list of all deleted records.
Recycle - To get the list of deleted records from recycle bin.
Permanent - To get the list of permanently deleted records.
The default value is All.
type
string
The type of users you want to fetch.
AllUsers - To get the list of all users.
ActiveUsers - To get the list of all active users.
DeactiveUsers - To get the list of all users who were deactivated.
ConfirmedUsers - To get the list of confirmed users.
NotConfirmedUsers - To get the list of non-confirmed users.
DeletedUsers - To get the list of deleted users.
ActiveConfirmedUsers - To get the list of active users who are also confirmed.
AdminUsers - To get the list of admin users.
ActiveConfirmedAdmins - To get the list of active users with the administrative privileges and are also confirmed.
CurrentUser - To get the current CRM user.
criteria
string
Performs search by following the criteria:
(({api_name}:{starts_with|equals}:{value})and/or({api_name} :{starts_with|equals}:{value})). Refer to our post on Search records for more details.
--
email
string
To perform module search by email. All the email fields of a particular module will be searched and listed.
--
phone
string
To perform module search by phone number. All the phone fields of a particular module will be searched and listed.
--
word
string
Performs a global search in a module by word.
--
group
string/integer
The unique ID or API name of the group to which the variable belongs.
--
my_tags
boolean
Display only the tags created by the current user.
true - displays the names of the tags created by the current user.
The default value is false.
job_id
string
Specifies the unique ID of the mass update job obtained in the response of Mass Update Records.
--
sharedTo
string
The current user’s ID to get the details like the ID and the module of the records shared with that user.
--
view
string
The details of the shared records that you want to retrieve.
summary, manage
id
string
The encrypted ID of the file you received in the response while uploading files to ZFS.
--
channel_id
integer
The unique ID of the notification channel.
--
ids
integer
The record IDs, separated by commas, of the records you want to fetch.
--
Here is an example that uses some of the parameters of the Get list of records API:
{{api-domain}}/crm/v2/Leads?fields=Created_By,Last_Name&sort_by=created_time&sort_order=desc&page=1&per_page=2

Here is the response:



We hope you found this post useful. Write to us at support@zohocrm.com if you have any questions, or share your thoughts in the comment section.

Cheers!






    Access your files securely from anywhere

        Zoho Developer Community







                                  Zoho Desk Resources

                                  • Desk Community Learning Series


                                  • Digest


                                  • Functions


                                  • Meetups


                                  • Kbase


                                  • Resources


                                  • Glossary


                                  • Desk Marketplace


                                  • MVP Corner


                                  • Word of the Day



                                      Zoho Marketing Automation


                                              Manage your brands on social media



                                                    Zoho TeamInbox Resources

                                                      Zoho DataPrep Resources



                                                        Zoho CRM Plus Resources

                                                          Zoho Books Resources


                                                            Zoho Subscriptions Resources

                                                              Zoho Projects Resources


                                                                Zoho Sprints Resources


                                                                  Qntrl Resources


                                                                    Zoho Creator Resources



                                                                        Zoho Campaigns Resources


                                                                          Zoho CRM Resources

                                                                          • CRM Community Learning Series

                                                                            CRM Community Learning Series


                                                                          • Kaizen

                                                                            Kaizen

                                                                          • Functions

                                                                            Functions

                                                                          • Meetups

                                                                            Meetups

                                                                          • Kbase

                                                                            Kbase

                                                                          • Resources

                                                                            Resources

                                                                          • Digest

                                                                            Digest

                                                                          • CRM Marketplace

                                                                            CRM Marketplace

                                                                          • MVP Corner

                                                                            MVP Corner





                                                                              Design. Discuss. Deliver.

                                                                              Create visually engaging stories with Zoho Show.

                                                                              Get Started Now