Sign in
PodsInboxes

List Inboxes

CLI:

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

Path parameters

pod_idstring required

ID of pod.

Query parameters

limitinteger

Limit of number of items returned.

page_tokenstring

Page token for pagination.

ascendingboolean

Sort in ascending temporal order.

Response

countinteger required

Number of items returned.

limitinteger

Limit of number of items returned.

next_page_tokenstring

Page token for pagination.

Changes

Changed in 5 of the 34 revisions of this API.118

  • 394ddcdd9c294See the full diff
    • ○

      added the optional property code to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property docs to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property fix to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property inboxes/items/metadata to the response with the 200 status

      response-optional-property-added

  • 27965096e6182See the full diff
    • ○

      added the new optional query request parameter ascending

      new-optional-request-parameter

    • ○

      added the required property inboxes/items/email to the response with the 200 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

  • 8a5b5e92ae2d11See the full diff
    • ▲

      removed the required property inboxes/items/email from the response with the 200 status

      response-required-property-removed

    • ●

      deleted the query request parameter ascending

      request-parameter-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 inboxes/items/email to the response with the 200 status

      response-required-property-added

  • 6e84a95db8ff1See the full diff
    • ○

      added the new optional query request parameter ascending

      new-optional-request-parameter