Kaizen #141 - Zoho CRM's API Collection in Postman

Kaizen #141 - Zoho CRM's API Collection in Postman

Hello everyone!
Welcome back to another week of Kaizen!

In today's post, we will discuss:
  1. What is Postman?
  2. Zoho CRM's API Collection in Postman
  3. Where is it available?
  4. Prerequisites for using the collection
  5. Forking the API Collection from Zoho CRM Developer Workspace
  6. Setting up the environment
  7. Registering a Client in Zoho API Console
  8. Generating tokens
  9. Making an API call
  10. A quick alternative to token generation using Guided Auth

1. What is Postman?

  • A popular tool for API development and testing.
  • User-friendly interface for making API requests, viewing responses, and managing different environments.

2. Zoho CRM's API Collection in Postman

  • Boilerplate requests that you can use to test and explore the CRM APIs in various environments for multiple organizations.
  • Makes the process of exploring APIs swift and effortless. It also significantly reduces the risk of errors.

3. Where is it available?

The Zoho CRM API Collection is available in Zoho Developers workspace in Postman.

4. Prerequisites for using the Collection

  • A Zoho CRM account to access the Zoho API Console.
  • A registered client (self-client/web-based) to generate an org-specific grant token.

5. Forking the API Collection from Zoho CRM Developer Workspace

  1. Download and install Postman.
  2. In the Postman app, click the search icon at the top bar and type Zoho CRM Developers. The Zoho CRM Developers Workspace opens.
  3. Click Collections on the left bar.
  4. Click the more actions icon.
  5. Click Create a Fork.
  6. Give a name to your collection, and choose the workspace you want to save it to.
  7. You can select one or more environments to fork and pin to the collection.
  8. Click Fork Collection. Forking will happen in the background.



6. Setting up the environment

An environment is a group of variables that you can reuse in API requests and scripts.
  1. Click Environments on the left bar.
  2. Click Create Environment and give it a name.
  3. Under Variable, add the following variables:
    client-id
    client-secret
    redirect-uri
    authorization-code
    access-token
    refresh-token
    accounts-url
    api-domain
    expiry-time


7. Registering a client in Zoho API Console

For your app to be able to use users' data in Zoho CRM across multiple orgs, you must register your app as a client in Zoho CRM.
In this post, we have used Self Client as the client type. For details about when to choose between a self-client and web-based client, refer to this Kaizen post.
  1. Go to Zoho API Console.
  2. Click Add Client.
  3. Choose Self Client from the list of client types and click Create Now.
  4. You will see the client ID and client secret.


8. Generating the tokens for a self client

Zoho CRM APIs follow the OAuth2.0 protocol for authentication.
This involves three tokens viz, grant token(authorization code), access token and refresh token.
  • Grant token - Also called the authorization code, for a self client, this token is generated in the API console itself. This token informs Zoho's authorization server(Zoho Accounts) that your app wants to access Zoho CRM users' data(bound by scopes). This token is environment-specific, i.e, if you choose a production org while generating this token, you can access Zoho CRM data in the production environment only. This token is valid from 3 minutes to 10 minutes based on what you choose in the console.
  • Access token - After you have authenticated your app and generated a grant token, you must exchange it with Zoho Accounts for an access token. This access token will also have the same scopes as your grant token. This token is valid for one hour. You must send this token in the header of every API call as a bearer token.
  • Refresh token - Since the access token is valid only for an hour, you can use the refresh token to generate a new access token. Instead of creating a grant token again for the same scopes and generating another access token, you can directly use the refresh token and get a new access token with the same scope. Refresh token is valid until you revoke it.
Let's see how to generate these tokens.



Notes
Creating the grant token is a one-time process. After you generate access and refresh tokens using the grant token, you can simply use the refresh token to create new access token every hour.

9. Making an API call

Now that we have generated the tokens, let's make an API call using the access token.
  1. Navigate to V6 > REST APIs > Records > Get Records > Accounts.
  2. You can see the request with a few fields already in place.
  3. Modify the parameters as required.
  4. Under Auth, you can see the variable {{access-token}} that holds the access token we generated earlier.
  5. Hit Send to get a response.



10. A quick alternative to token generation using Guided Auth

Postman has introduced a new flow called the Guided Auth. This method allows new users to acquaint themselves with making API calls and testing them, without the hassIe of setting up a client.
In this flow, Zoho acts as the client and takes care of generating the grant and access tokens for a set of pre-defined scopes.
Follow these steps to use Guided Auth.
  1. Click Set Up New Authorization in Postman.
  2. Click Authorize. You will be redirected to Zoho's Login page.
  3. Sign in to your Zoho account.
  4. Choose the org for which you want to generate the token.
  5. Click Agree on the consent screen to grant permission to use your Zoho CRM data as per the scopes on the screen.
In the backend, Zoho generates the grant and access tokens, and you will see the access token in your Postman instance under Auth Credentials.
Note that flow does not give you a refresh token. This method is only to get a head-start with APIs without facing authorization errors. As always, the access token is valid for an hour, after which you have to follow the process of authorizing Zoho to generate another token.





As you can see, when you use our API collection, making API calls to Zoho CRM is a piece of cake as all the requests are already in place with examples.


We hope you found this post useful. We'll meet you next week with another interesting post!
Let us know your feedback in the comment section or write to us at support@zohocrm.com.
Cheers!


    Access your files securely from anywhere

        All-in-one knowledge management and training platform for your employees and customers.






                              Zoho Developer Community




                                                    • Desk Community Learning Series


                                                    • Digest


                                                    • Functions


                                                    • Meetups


                                                    • Kbase


                                                    • Resources


                                                    • Glossary


                                                    • Desk Marketplace


                                                    • MVP Corner


                                                    • Word of the Day


                                                    • Ask the Experts



                                                              • Sticky Posts

                                                              • Kaizen #198: Using Client Script for Custom Validation in Blueprint

                                                                Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
                                                              • Kaizen #226: Using ZRC in Client Script

                                                                Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In this
                                                              • Kaizen #222 - Client Script Support for Notes Related List

                                                                Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore how
                                                              • Kaizen #217 - Actions APIs : Tasks

                                                                Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.
                                                              • Kaizen #216 - Actions APIs : Email Notifications

                                                                Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are


                                                              Manage your brands on social media



                                                                    Zoho TeamInbox Resources



                                                                        Zoho CRM Plus Resources

                                                                          Zoho Books Resources


                                                                            Zoho Subscriptions Resources

                                                                              Zoho Projects Resources


                                                                                Zoho Sprints Resources


                                                                                  Qntrl Resources


                                                                                    Zoho Creator 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


                                                                                              Zoho Show Resources

                                                                                                Zoho Writer

                                                                                                Get Started. Write Away!

                                                                                                Writer is a powerful online word processor, designed for collaborative work.

                                                                                                  Zoho CRM コンテンツ






                                                                                                    Nederlandse Hulpbronnen


                                                                                                        ご検討中の方




                                                                                                                • Recent Topics

                                                                                                                • List of All Contacts on "Do-Not-Mail List"

                                                                                                                  I have several contacts that are UNKNOWN among my thousands of email addresses who would like to be put back on the active mailing list.  I require a list of ALL my contacts on "Do-Not-Mail List" - How to I receive this list? Note: "We're sorry, but this is not possible" is not an acceptable answer. I must receive this list form Zoho Campaigns or directly from someone within Zoho Technical Support.  Thank you, Justin
                                                                                                                • Cliq Bots - Post message to a bot using the command line!

                                                                                                                  If you had read our post on how to post a message to a channel in a simple one-line command, then this sure is a piece of cake for you guys! For those of you, who are reading this for the first time, don't worry! Just read on. This post is all about how
                                                                                                                • Auto-sync field of lookup value

                                                                                                                  This feature has been requested many times in the discussion Field of Lookup Announcement and this post aims to track it separately. At the moment the value of a 'field of lookup' is a snapshot but once the parent lookup field is updated the values diverge.
                                                                                                                • Edit 'my' Notes only

                                                                                                                  The permissions around Notes should be more granular, and allow to user to be able to edit the notes he created only. The edit Notes permission is useful as it allows the user to correct any mistakes or add information as needed. However, with this same
                                                                                                                • [Free webinar series] Get to know Deluge: Zoho’s powerful scripting language

                                                                                                                  Hello Everyone, We are much elated to invite you all to our upcoming session in Zoho Deluge! Bringing on to your table - Get to know Deluge: Zoho’s powerful scripting language Understanding Deluge Zoho’s suite of applications offers robust solutions for
                                                                                                                • Account blocked

                                                                                                                  Yesterday I got my Zeptomail account blocked due to too many hard bounces. My account is used exclusively for sending transactional emails (eg. your order has been shipped, a form has been filled, etc) and the sudden blocking impacted hundreds of websites
                                                                                                                • What is wrong with this sendmail message?

                                                                                                                  I keep getting improper statement errors on the message, but I cannot see a problem. Also, if the message is much longer the whole message turns black instead of being coloured yellow, red and blue. client = Clients[ID == input.Client_Lookup]; sendmail
                                                                                                                • How to size a QR image in a report PDF?

                                                                                                                  I've created a report template for a client record which has a QR code field. I've tried inserting the field into a paragraph element and also as a field element that I have resized. The QR code is shown at the same, large size on the page either way.
                                                                                                                • How do create a validation rule / function to check datetime field is within Business Hours?

                                                                                                                  I've got a field called Scheduled_Time. People keep accidently inputting 2am when they mean 2pm. Realistically this field is never going to be before 7am or after 9pm. I'd like to add validation rule to the field (which is a datetime field). Using the
                                                                                                                • Creating a report for a subform child record and show parent data

                                                                                                                  I have a Client form (Name, Address) under which I can add a child Appointment (Date, Time, Location, SalesRep) in a subform. Now I want to set up a report where I can view an Appointment and send it to a Sales rep for their records. I want to automatically
                                                                                                                • Tropicalize Books

                                                                                                                  Books is an incredibly powerful tool that works well in many countries. But I feel that it is a product that is not yet "tropicalized" for Brazil as we speak (this would be like adapting the local reality). We have many strong competitors who do more
                                                                                                                • Generate print-ready documents from Zoho Books with the Zoho Writer extension

                                                                                                                  Hi everyone, We're excited to introduce Zoho Writer Templates for Zoho Books extension. This extension allows you to create and use customized templates to generate professional, print-ready documents such as invoices, estimates, purchase orders, and
                                                                                                                • Tip #73 - Exploring Technician Console: Diagnostics - 'Insider Insights'

                                                                                                                  Hello Zoho Assist Community! Say you're remotely supporting a client whose machine is behaving erratically. Applications are freezing, services keep stopping on their own, and the user has no idea what's going wrong under the hood. You need to dig deeper,
                                                                                                                • Replies sometimes creating separate ticket

                                                                                                                  Sometimes when a customer responds to an email coming from Zoho Desk, instead of adding a reply to the original ticket, a separate ticket is created. This happens even though the response subject line contained the ticket number, and the person responding
                                                                                                                • NEED HELP

                                                                                                                  I have below data po no invoice no Party inv date value status 1 aa1 ABC 01-May-26 100 Under Cr 2 aa2 XYZ 02-May-26 200 Over Due 3 aa3 ABC 02-May-26 300 Under Cr 4 aa4 XYZ 03-May-26 400 Under Cr I need result as below using formulas (not Pivot table)
                                                                                                                • Pasting images is a mess

                                                                                                                  I’m trying to paste images into my tickets, in the comments field. But when I paste images, they end up in the wrong order or behind the text.
                                                                                                                • A way to create kits (groups of items) that do not require bundling and are added to an order as the individual items

                                                                                                                  We are evaluating moving off of Sage BusinessWorks (which handles accounting, order entry, inventory control, accounts receivable, etc) to Zoho Books/Inventory. One of the things we heavily use is a feature called Kits, which allows creating a group of
                                                                                                                • Refering cell from other sheet

                                                                                                                  Hi, If we want to refer any cell in the same sheet its very easy, like suppose if I want to refer cell A2  in P7 I just need to type =A2 in P7, similarly how can I refer a cell present in different sheet ( I mean refer cell A2 from Sheet1 into Sheet2) Thanks
                                                                                                                • How to prevent users from switching price lists in an order?

                                                                                                                  Hi, I have Zoho Finance integrated with Zoho CRM. My team will be placing orders through the CRM using the Finance module. When creating a new customer I will assign it a price list, I don't want the sales rep to switch to a different Price List, other
                                                                                                                • Invoice emails repeatedly "Bounced back" from perfectly good email address of clients.

                                                                                                                  Hi For a couple of months now I am getting tens of invoice email invoices "bounced back" from perfectly sound email addresses when they are sent via Zoho Books. (see attached or an example) (the common theme seems to be that the emails are going to either
                                                                                                                • Paying a credit card

                                                                                                                  When you move money from your operating account to the credit card account to pay the balance does you select "Pay Credit Card" or "Transfer". Doers it matter? Also I seem to be doing transfers and sometimes I get a list of possible matches and I select
                                                                                                                • Timer not appearing to update

                                                                                                                  For the last couple of days, I've noticed my timer is not updating. When I start it, it doesn't show as started until I refresh the page. When I pause it, it doesn't show as paused until I refresh the page. But it does register a stop correctly in real
                                                                                                                • Proforma Invoice

                                                                                                                  Is there an option to create proforma and advance invoices in professional
                                                                                                                • Zoho Books | Product updates | May 2026

                                                                                                                  Hello users, We're back with the latest updates and enhancements we've rolled out in Zoho Books. From sales tax automation to scanning receipts for free, explore the updates designed to upgrade your bookkeeping experience. Sales Tax Automation [US & Canada
                                                                                                                • Restrict Ticket Movement to Specific Departments in Zoho Desk

                                                                                                                  Hello Zoho Desk Team, Greetings, and hope you are doing well. We would like to submit a feature request regarding the ability to control ticket movement between departments in Zoho Desk. Current Limitation: At present, Zoho Desk allows agents to move
                                                                                                                • Bounced Contacts

                                                                                                                  We recently started using Zoho and hadn’t sent out campaigns in quite some time. With our first campaign, we saw a high number of bounce backs, which we expected due to the age of some contacts in our database. After doing some research, I understood
                                                                                                                • DYK 5 - Soft and Hard Links in Task Dependency

                                                                                                                  Did You Know you can manage dependent task schedules with Zoho Projects? In a project, some tasks are linked while others progress on their own. When a task is hard linked to another, its schedule is automatically adjusted when the predecessor moves.
                                                                                                                • No Ability to Rename Record Template PDFs in SendMail Task

                                                                                                                  As highlighted previously in this post, we still have to deal with the limitation of not being able to rename a record template when sent as a PDF using the SendMail Task. This creates unnecessary complexity for what should be a simple operation, and
                                                                                                                • Whats app integration

                                                                                                                  Do we have a whats app integration as wel for Zoho recruit please.. If so how can we process it
                                                                                                                • Global/Overall Reports & Dashboards in Zoho Sprints

                                                                                                                  Hi, Do we have an option to refer Global Level Reports & Dashboards in Zoho Sprints? We could see that we have Project specific Reports & Dashboards inside every Project. However, for a management level we want Reports & Dashboards visibility at a Global
                                                                                                                • AI-Powered Summaries for Records, Notes, and Emails

                                                                                                                  Recruiters spend a significant part of their day catching up on context. Reviewing candidate records before a call, scrolling through notes after an interview, or reading lengthy email threads to understand the latest update. As hiring volume grows, finding
                                                                                                                • Cross Module Filtering – Use Fields from Lookup modules in Custom Views criteria and Advanced Filters

                                                                                                                  Hello everyone, Zoho CRM now enables you to achieve deeper filtering of records in a module, using fields of a lookup, thereby enhancing your data management experience manifold. This filtering based on lookup module fields is now available in advanced
                                                                                                                • Zoho Recruit Extension - Recruit Variables

                                                                                                                  I am creating a zoho recruit extension. I have created a zoho recruit variable "token". The user who installs the token is supposed to fill this field. This is now connected with a workflow of "Job Create". I am using a deluge function that sends ths
                                                                                                                • Direct URL to "View Record"

                                                                                                                  I would like to create a button (Deluge Script) to jump to the "view record" without passing by the record menu, but I can not aford to find the right url. I don't want the "view record" as a single page. I want the "view record" in the application like the picture below: Thanks in advance for your help
                                                                                                                • Zoho recruit's blueprint configuration is not functioning as mapped

                                                                                                                  Current Status: Zoho Blueprint is not functioning as configured. Issue: We are moving a Candidate status in Zoho Recruit "for active file" but we encountered: "Status cannot be changed for records involved in Blueprint." This happens to various client
                                                                                                                • Interview Notes and Feedback

                                                                                                                  We hold panel interviews and would like an option for all panel members to leave independent interview feedback and notes. At present, we can only see an option for a single person to do that. Is there a way multiple people can leave centralised feedback
                                                                                                                • WF On User Input of Field calling a function

                                                                                                                  As the Title implies, I have an Invoice form with a Lookup field called Car. When the user enters a value, I want to create a series of SubForm (charge) rows with data entries that depend on the Car form. I have a Function that describes how many lines
                                                                                                                • site24x7

                                                                                                                  regards the "www.site24x7.com" service is included in the service of zoho one If included please enable it in my zoho one service Thank you
                                                                                                                • UK MTD -- do we really need to map accounts every time we finalise a quarterly report?

                                                                                                                  Hi, I've been using Books for years as a sole trader in the UK and been very happy with it overall. I was expecting that their implementation of features for MTD was going to be seamless and helpful. Unfortunately, it seems very bare bones and unclear.
                                                                                                                • How do I remove a data source from Zoho Analytics?

                                                                                                                  I am unable to find a delte option on a datasource that i put in the system as an error. On teh web it refers to a setup icon but I do not see that on my interface?
                                                                                                                • Next Page