Your AWS SES. Your dedicated Mailat. See how it works
Documentation

Get Shared Mailbox

Request, response and authentication details for your Mailat instance.

← All API operations
GET/api/v1/shared-mailboxes/{id}

GetSharedMailbox gets a shared mailbox GET /api/v1/shared-mailboxes/:id

Authentication & compatibility

This operation requires an active human session. API keys cannot call it. Additional role or MFA checks may apply.

Legacy stored configuration; not wired to SES ingestion. Storing a Sieve script, shared mailbox, auto-reply or forward does not enable its execution. Use /inbox/filters and external webhook workflows for supported SES organization/reply/forward automation.

Contract 2026-10-04. Your running instance's /api/v1/openapi.json is authoritative for its deployed release.

Request

Set MAILAT_BASE_URL to your instance origin (without /api/v1) and MAILAT_TOKEN to an appropriate credential. Replace path placeholders and example data before running. These examples do not execute in this page.

cURL request
curl --request GET "$MAILAT_BASE_URL/api/v1/shared-mailboxes/{id}" \
  --header "Authorization: Bearer $MAILAT_TOKEN"

Parameters

path
idstringrequired

Responses

HTTP statuses and body shapes below come from the pinned contract. Not every shared error applies to every request. Retain the original idempotency key when retrying a send.

200 · Success

application/json

responseobject
Fields
codeintegerrequired
dataall of · nullable
Variant 1object
Fields · service.SharedMailbox
autoReplyEnabledboolean
createdAtstring (date-time)
descriptionstring
emailstring
idinteger (int64)
memberCountinteger (int64)
namestring
orgIdinteger (int64)
updatedAtstring (date-time)
uuidstring
messagestringrequired
400 · Invalid input

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
401 · Missing, expired or revoked authentication

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
403 · Insufficient permission

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
404 · Resource not found

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
409 · Conflict or changed idempotency payload

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
410 · Recovery cursor expired; resynchronize

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
429 · Rate limit exceeded; respect Retry-After
Header: Retry-Afterinteger

Seconds until the next fixed-minute request window.

minimum: 1

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
500 · Internal failure; retain the idempotency key

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
Download the full OpenAPI contract