Mailboxes API

4 operations. Guide: Send as a person from a mailbox. Requests and responses are JSON with snake_case fields; authenticate with Authorization: Bearer <api key>. The examples assume a client built as in SDKs and the command line.

List connected mailboxes

GET /v1/mailboxes

Operation listMailboxes, SDK minket.mailboxes.list. Keys: full access. Test keys work on test-mode data.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"list"	yes
`data`	array of Mailbox	yes
`data[].id`	string	yes	A UUID.
`data[].object`	"mailbox"	yes
`data[].project_id`	string	yes	A UUID.
`data[].provider`	one of "gmail", "microsoft", "smtp"	yes
`data[].address`	string	yes
`data[].display_name`	string or null	yes
`data[].status`	one of "connected", "needs_reconnect", "disabled"	yes
`data[].saves_sent_copy`	boolean	yes
`data[].last_used_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].last_error`	string or null	yes
`data[].created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`has_more`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/mailboxes \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.mailboxes.list();

CLI

minket api listMailboxes

Python

from minket.api.mailboxes import list_mailboxes

result = list_mailboxes.sync(client=client)

res, err := client.ListMailboxesWithResponse(ctx)

Connect a mailbox

POST /v1/mailboxes

SMTP mailboxes are verified with a test login (and IMAP for Sent copies) and stored at once; Gmail and Microsoft return a consent URL, valid for 10 minutes, and the mailbox appears after the person consents. Connecting the same SMTP address or account again reconnects the mailbox in place. return_url must share its origin with the project's OAuth redirect URI or the console.

Operation createMailbox, SDK minket.mailboxes.create. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Request body

object

Response

201 Created or consent URL: Mailbox or object.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/mailboxes \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"provider":"smtp","address":"support@acme.example","display_name":"Support","smtp":{"host":"smtp.acme.example","port":587,"username":"support@acme.example","password":"app-password","secure":"starttls"}}'

TypeScript

const result = await minket.mailboxes.create({
  provider: "smtp",
  address: "support@acme.example",
  display_name: "Support",
  smtp: {
    host: "smtp.acme.example",
    port: 587,
    username: "support@acme.example",
    password: "app-password",
    secure: "starttls"
  }
});

CLI

minket api createMailbox --body '{"provider":"smtp","address":"support@acme.example","display_name":"Support","smtp":{"host":"smtp.acme.example","port":587,"username":"support@acme.example","password":"app-password","secure":"starttls"}}'

Python

from minket.api.mailboxes import create_mailbox
from minket.models import CreateMailboxBodyType0

result = create_mailbox.sync(client=client, body=CreateMailboxBodyType0.from_dict({"provider":"smtp","address":"support@acme.example","display_name":"Support","smtp":{"host":"smtp.acme.example","port":587,"username":"support@acme.example","password":"app-password","secure":"starttls"}}))

var body minket.CreateMailboxJSONRequestBody
res, err := client.CreateMailboxWithResponse(ctx, body)

Get a mailbox

GET /v1/mailboxes/{id}

Operation getMailbox, SDK minket.mailboxes.get. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

200 Success: Mailbox.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"mailbox"	yes
`project_id`	string	yes	A UUID.
`provider`	one of "gmail", "microsoft", "smtp"	yes
`address`	string	yes
`display_name`	string or null	yes
`status`	one of "connected", "needs_reconnect", "disabled"	yes
`saves_sent_copy`	boolean	yes
`last_used_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`last_error`	string or null	yes
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/mailboxes/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.mailboxes.get("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api getMailbox 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.mailboxes import get_mailbox

result = get_mailbox.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.GetMailboxWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Disconnect a mailbox

DELETE /v1/mailboxes/{id}

Operation deleteMailbox, SDK minket.mailboxes.delete. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"mailbox"	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X DELETE https://api.minket.com/v1/mailboxes/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.mailboxes.delete("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api deleteMailbox 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.mailboxes import delete_mailbox

result = delete_mailbox.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.DeleteMailboxWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Updated 30 October 2026