ClosersHQ.io | Help
HomePricingBlogLogin
  • What is ClosersHQ?
  • EMAIL WARMING
    • Setup & Configuration Guide
      • Google Workspace (Gmail | G-suite)
      • Microsoft Office 365 (Outlook)
      • SMTP/IMAP (C-Panel & Other Custom Providers)
        • SMTP/IMAP Configuration Flow
        • Zoho IMAP & SMTP
        • Yahoo Mail SMTP & IMAP
        • AWS SES Configuration
        • SendGrid Configuration
        • MailGun Configuration
        • GSuite | Gmail SMTP/IMAP
        • Microsoft Office 365 SMTP & IMAP
    • How to Switch ON and OFF Email Warming
    • How to Configure Mailbox Warming Pattern
    • How to View Email Warmup Analytics
    • How to Create Inbox Filter
  • Email campaign
    • How It Works
    • How to Use Spintax in Cold Email
    • How to Create and Use Personalization in Emails
    • Email Signature - How to Set and Use Sender Variables
    • How to Edit Unsubscribe Text
    • How to Set Mailbox Sending Pattern and Daily Limits
    • How to Set up Custom Domain Tracking
    • How to Create and Use Email Templates
    • Blocklist - What It Entails and How to Manage It
    • How to Add a Team Member
  • API
    • API Documentation
    • Campaign API
    • Prospect API
  • Webhook
    • Webhook Event
Powered by GitBook
On this page

Was this helpful?

  1. API

API Documentation

This section contains guides about the API, resource path, authentication, etc.

PreviousHow to Add a Team MemberNextCampaign API

Last updated 2 years ago

Was this helpful?

Authentication:

The primary authentication for all routes is the API key. ClosersHQ's API accepts the Bearer Authentication.

How to get the API Key:

Use the API copied to make a request, as in the example below:

import axios from "axios"

var options = {
  method: 'GET',
  url: 'https://api.closershq.io/v1/crm/prospect',
  headers: {
    Accept: '*/*',
    Authorization: 'Bearer {{the copied API Key}}'
  }
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

How to get the API key