Using Gmail JavaScript API to Search Email Threads

This code uses the Gmail JavaScript API to search the inbox of the authenticated user (userId = me) for email threads that match the specified query. You need to create a new project in Google developer console with the Gmail API enabled.

The scope can be https://www.googleapis.com/auth/gmail.readonly since this Gmail app requires only read only access to the user’s mailbox.

var threads = function listGmailThreads(userId, query, callback) {
  var getPageOfThreads = function (request, result) {
    request.execute(function (resp) {
      result = result.concat(resp.threads);
      var nextPageToken = resp.nextPageToken;
      if (nextPageToken) {
        request = gapi.client.gmail.users.threads.list({
          userId: userId,
          q: query,
          pageToken: nextPageToken,
        });
        getPageOfThreads(request, result);
      } else {
        callback(result);
      }
    });
  };
  var request = gapi.client.gmail.users.threads.list({
    userId: userId,
    q: query,
  });
  getPageOfThreads(request, []);
};
Amit Agarwal

Amit Agarwal

Google Developer Expert, Google Cloud Champion

Amit Agarwal is a Google Developer Expert in Google Workspace and Google Apps Script. He holds an engineering degree in Computer Science (I.I.T.) and is the first professional blogger in India.

Amit has developed several popular Google add-ons including Mail Merge for Gmail and Document Studio. Read more on Lifehacker and YourStory

Awards & Titles

Digital Inspiration has won several awards since it's launch in 2004.

Google Developer Expert

Google Developer Expert

Google awarded us the Google Developer Expert award recogizing our work in Google Workspace.

ProductHunt Golden Kitty

ProductHunt Golden Kitty

Our Gmail tool won the Lifehack of the Year award at ProductHunt Golden Kitty Awards in 2017.

Microsoft MVP Alumni

Microsoft MVP Alumni

Microsoft awarded us the Most Valuable Professional (MVP) title for 5 years in a row.

Google Cloud Champion

Google Cloud Champion

Google awarded us the Champion Innovator title recognizing our technical skill and expertise.

Email Newsletter

Sign up for our email newsletter to stay up to date.

We will never send any spam emails. Promise.