Theme
Developer Documentation

API Reference

Build powerful integrations with the Icebox API. Access emails, contacts, and more programmatically.

Get API KeyQuick Start Guide

RESTful Design

Clean, predictable URLs and standard HTTP methods

Secure by Default

OAuth 2.0 and API key authentication options

Real-time Webhooks

Get notified instantly when events occur

Official SDKs

Libraries for popular languages and frameworks

Base URL
https://api.icebox.cool/v1

Quick Start

Get up and running with the Icebox API in minutes.

JavaScript
// Install the SDK
npm install @icebox/sdk

// Initialize the client
import { Icebox } from '@icebox/sdk';

const icebox = new Icebox({
  apiKey: 'your_api_key_here'
});

// Fetch emails from inbox
const emails = await icebox.emails.list({
  folder: 'inbox',
  limit: 10
});

console.log(emails);
cURL Request
curl -X GET "https://api.icebox.cool/v1/emails" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Response
{
  "data": [
    {
      "id": "msg_abc123",
      "subject": "Welcome to Icebox",
      "from": {
        "email": "hello@icebox.cool",
        "name": "Icebox Team"
      },
      "date": "2025-01-15T10:30:00Z",
      "snippet": "Thanks for signing up...",
      "labels": ["inbox", "unread"]
    }
  ],
  "pagination": {
    "total": 156,
    "page": 1,
    "per_page": 10
  }
}

API Endpoints

Explore the available endpoints organized by resource.

Emails

Send, receive, and manage email messages

GET/emailsList all emails
GET/emails/{id}Get a specific email
POST/emailsSend a new email
PUT/emails/{id}Update email metadata
DELETE/emails/{id}Delete an email

Contacts

Manage your address book and contact information

GET/contactsList all contacts
GET/contacts/{id}Get a specific contact
POST/contactsCreate a new contact
PUT/contacts/{id}Update a contact
DELETE/contacts/{id}Delete a contact

Folders & Labels

Organize emails with folders and labels

GET/foldersList all folders
POST/foldersCreate a new folder
GET/labelsList all labels
POST/labelsCreate a new label

Webhooks

Receive real-time notifications for events

GET/webhooksList webhook subscriptions
POST/webhooksCreate a webhook
DELETE/webhooks/{id}Delete a webhook

Account

Manage account settings and preferences

GET/accountGet account details
PUT/accountUpdate account settings
GET/account/usageGet API usage stats

Attachments

Upload and download email attachments

GET/attachments/{id}Download attachment
POST/attachmentsUpload attachment
DELETE/attachments/{id}Delete attachment

Official SDKs

Use our official libraries to integrate faster.

JavaScript / TypeScript

npm install @icebox/sdk

Python

pip install icebox-sdk

Ruby

gem install icebox

Go

go get github.com/icebox/sdk-go

Rate Limits

API rate limits are based on your subscription tier.

TierRate LimitDaily Limit
Free100 requests/min1,000/day
Pro1,000 requests/min50,000/day
Business5,000 requests/min250,000/day
EnterpriseCustomUnlimited

Authentication

All API requests require authentication via API key or OAuth 2.0 token. Include your credentials in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Ready to get started?

Create an API key and start building your integration today.

Get API KeyRead Full Documentation →
← Back to Home