Developer First

Build on top of email
in minutes.

InboxParse is the infrastructure layer for email-native AI applications. We handle the IMAP protocols, HTML cleaning, and AI processing, so you can focus on building your product with a clean REST API.

REST API

Predictable JSON responses, standard Bearer auth, and cursor-based pagination.

AI-Ready Data

Get clean Markdown, summaries, and intent labels in every message object.

Secure by Design

AES-256 encryption at rest, TLS 1.2+ in transit, and scoped API keys.

Quickstart

Get started with InboxParse in less than 2 minutes. Follow these three steps to turn your first email into structured data.

1

Get your API Key

Sign up at console.inboxparse.com and grab your key from the settings tab.

2

Connect a Mailbox

Add your IMAP or Gmail account. We'll start syncing and processing immediately.

3

Run your first query

Use the /emails endpoint to retrieve processed, AI-enriched data.

Authentication

All requests require an API key via the `Authorization` header. You can manage your API keys in the developer console.

Authorization: Bearer ip_your_api_key_here

Errors

We use standard HTTP response codes to indicate the success or failure of an API request. In general: 2xx means success, 4xx means you did something wrong, and 5xx means our servers are having an issue.

Status	Description
400	Bad Request — Often missing parameters.
401	Unauthorized — Invalid or missing API key.
429	Too Many Requests — Rate limit hit.

API Reference

Complete reference for the InboxParse REST API. All requests are made to https://inboxparse.com/api/v1

Emails

List and retrieve emails with AI-enriched data

get/emails—List emails

Returns a paginated list of emails with AI processing data. Use cursor-based pagination for large result sets.

Parameters

limitquery

Results per page (1-100)

cursorquery

Pagination cursor from previous response

formatquery

Email content format

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

date_fromquery

Filter from date (ISO 8601)

date_toquery

Filter to date (ISO 8601)

directionquery

Filter by direction

mailbox_idquery

Filter by mailbox ID

get/emails/{id}—Get email

Returns a single email with full content, AI data, and attachment metadata.

Parameters

idpathrequired

Email ID

formatquery

Email content format

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

post/emails/send—Send email

Send a new email via SMTP. Creates a new thread. Requires admin API key.

post/emails/reply—Reply to email

Reply to an existing email with proper threading headers. Uses the original thread. Requires admin API key.

Threads

Email threads with participants and summaries

get/threads—List threads

Returns paginated email threads with participant info, labels, and AI summaries.

Parameters

limitquery

Results per page (1-100)

cursorquery

Pagination cursor from previous response

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

searchquery

Full-text search query

date_fromquery

Filter from date (ISO 8601)

date_toquery

Filter to date (ISO 8601)

get/threads/{id}—Get thread

Returns a thread with all its messages. Messages are ordered by sent_at ascending.

Parameters

idpathrequired

Thread ID

formatquery

Email content format for messages

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

Search

Full-text, semantic, and hybrid email search

post/search—Search emails

Search emails using full-text, semantic (vector), or hybrid search. Hybrid mode combines both for best results.

Parameters

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

Mailboxes

Connected mailboxes (IMAP and Gmail)

get/mailboxes—List mailboxes

Returns all connected mailboxes (IMAP and Gmail) for the workspace.

Parameters

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

post/mailboxes—Create IMAP mailbox

Create a new IMAP mailbox with encrypted credentials. Passwords are encrypted at rest. Requires admin API key.

delete/mailboxes/{id}—Delete mailbox

Delete a mailbox and all associated data. Requires admin API key.

Parameters

idpathrequired

Mailbox ID

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

Labels

AI classification labels

get/labels—List labels

Returns all labels for the workspace, ordered by display order.

Parameters

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

post/labels—Create label

Create a new AI classification label. Requires admin API key.

Parameters

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

patch/labels/{id}—Update label

Update a label's name, color, or AI classification prompt. System labels are read-only. Requires admin API key.

Parameters

idpathrequired

Label ID

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

delete/labels/{id}—Delete label

Delete a custom label. System labels cannot be deleted. Cascade deletes all message-label associations. Requires admin API key.

Parameters

idpathrequired

Label ID

Webhooks

Real-time event notifications

get/webhooks—List webhooks

Returns all webhook subscriptions for the workspace.

Parameters

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

post/webhooks—Create webhook

Register a new webhook endpoint. Requires admin API key.

Parameters

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

patch/webhooks/{id}—Update webhook

Update a webhook subscription. Re-enabling an inactive webhook resets its failure count. Requires admin API key.

Parameters

idpathrequired

Webhook ID

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

delete/webhooks/{id}—Delete webhook

Delete a webhook subscription. Requires admin API key.

Parameters

idpathrequired

Webhook ID

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

post/webhooks/{id}/test—Test webhook

Send a test event to a webhook endpoint. Returns the delivery result including response status.

Parameters

idpathrequired

Webhook ID

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

Usage

Billing period usage statistics

get/usage—Get usage

Returns usage statistics for the current billing period (calendar month).

Parameters

compactquery

Token efficiency mode. When `true`, shortens JSON keys and appends a `_dict` mapping of short → full key names. Useful for LLM consumers to reduce token usage.

Need help?

Can't find what you're looking for? Our team is ready to help you build.