Mailactor
API reference

Get an inbox

Required scope: mailbox:read.

GET/v1/inboxes/{inboxId}

Authorization

tenantApiKey
x-api-key<token>

A scoped tenant key returned once by an operator. Never place it in URLs, logs, prompts, or client-side application code.

In: header

Path Parameters

inboxId*string
Match^inb_[a-f0-9]{24}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

# Set the API key and replace resource IDs with your saved IDs.curl --fail-with-body --silent --show-error -X GET \  "https://api.mailactor.com/v1/inboxes/$INBOX_ID" \  -H "x-api-key: $MAILACTOR_API_KEY"

Response examples

Illustrative values; save the IDs and limits returned by your own requests.

HTTP 200

{
  "id": "inb_0123456789abcdef01234567",
  "localPart": "research-agent",
  "domainId": null,
  "domainKind": "managed",
  "domain": "inbox.mailactor.com",
  "address": "research-agent@inbox.mailactor.com",
  "displayName": "Research Agent",
  "status": "active",
  "createdAt": "2026-09-08T12:00:00.000Z",
  "updatedAt": "2026-09-08T12:00:00.000Z"
}