Saleshandy API

Introduction

Welcome to the Saleshandy API documentation.

The Saleshandy API enables you to programmatically manage and automate your sales outreach workflows. It provides access to core resources such as prospects, email sequences, email accounts, tasks, and campaign analytics.

With the API, you can integrate Saleshandy into your existing systems, automate repetitive tasks, and build scalable outreach processes tailored to your workflow.

Integration Options

Saleshandy offers three ways to interact with your data programmatically — choose what fits your workflow best:

Option	Best For
REST API	Custom integrations, backend services, any language or HTTP client
CLI	Terminal workflows, shell scripts, CI/CD pipelines
MCP	Controlling Saleshandy via AI assistants like Claude or Cursor

What You Can Do

Using the Saleshandy API, you can:

• Manage Prospects — Import, update, enrich, and organize your contact database at scale
• Automate Sequences — Create and control multi-step email campaigns with intelligent follow-ups
• Manage Email Accounts — Connect, configure, and monitor your sending accounts
• Handle Tasks — Manage sales tasks, assign them to team members, and bulk-update their status
• Track Engagement — Monitor opens, clicks, replies, and bounces in real-time
• Access Analytics — Pull comprehensive reports on sequences, email accounts, and team performance
• Unified Inbox — Read and reply to emails, update outcomes, and track unread counts
• Do Not Contact — Maintain DNC lists to stay compliant and protect sender reputation
• Lead Enrichment — Enrich contacts and companies with verified data and phone numbers

Base URL

All API requests should be made to:

https://open-api.saleshandy.com/v1

Authentication

Every API request must include your API key in the x-api-key header.

Get Your API Key:

1. Log in to your Saleshandy account
2. Navigate to Settings → API
3. Generate and copy your API Key

curl -X GET "https://open-api.saleshandy.com/v1/sequences" \
  -H "x-api-key: YOUR_API_KEY"

Security Note: Keep your API key secure. Never expose it in client-side code or public repositories.

Quick Start

Here's a simple example to fetch your sequences:

curl -X GET "https://open-api.saleshandy.com/v1/sequences" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response:

{
  "message": "Sequences fetched successfully",
  "payload": {
    "sequences": [
      {
        "id": "seq_123",
        "name": "Cold Outreach Campaign",
        "status": "active"
      }
    ],
    "total": 1
  }
}

Response Format

Success Response:

{
  "message": "Success message",
  "payload": {
    // Response data
  }
}

Error Response:

{
  "error": true,
  "type": "auth",
  "code": 1001,
  "message": "Invalid access token",
  "payload": null
}

HTTP Methods

The API uses standard HTTP methods:

• GET — Retrieve resources
• POST — Create new resources
• PUT — Update existing resources
• DELETE — Remove resources

API Characteristics

• RESTful Architecture — Predictable resource-oriented URLs
• JSON Responses — All responses are returned in JSON format
• HTTP Status Codes — Standard status codes for success and error states
• Rate Limiting — Fair usage limits to ensure service reliability
• Secure Authentication — API key-based authentication for all requests

What's Next

• CLI — Manage Saleshandy directly from your terminal
• MCP — Control Saleshandy via AI assistants like Claude and Cursor
• Prospects API — Manage your contact database
• Sequences API — Automate your email campaigns
• Analytics API — Track and measure performance