Sign in
PodsInboxes

Get Inbox

CLI:

agentmail pods:inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
get/v0/pods/{pod_id}/inboxes/{inbox_id}

Path parameters

pod_idstring required

ID of pod.

inbox_idstring required

The ID of the inbox.

Response

pod_idstring required

ID of pod.

inbox_idstring required

The ID of the inbox.

emailstring required

Email address of the inbox.

display_namestring

Display name: Display Name <username@domain.com>.

client_idstring

Client ID of inbox.

metadataInboxesMetadata

Custom key-value pairs attached to the inbox. Up to 256 keys. Keys and string values are each limited to 256 characters. When updating metadata, send a key with a null value to remove that key.

updated_atstring date-time required

Time at which inbox was last updated.

created_atstring date-time required

Time at which inbox was created.

Changes

Changed in 4 of the 34 revisions of this API.16

  • 394ddcdd9c294See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 27965096e6181See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8a5b5e92ae2d1See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    This revision also has 28 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7fdcd6b4651f1See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added