AGagentmail-to
threads

List Threads

Changed on

Lists threads, most recent first. Pass senders, recipients, or subject to filter by substring. Filtered requests are served by search, which caps limit at 100. For relevance-ranked full-text search across senders, recipients, subject, and message body, use Search Threads.

CLI:

agentmail threads list
get/v0/threads

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/threads
  • Auth
    HTTP bearer

Query parameters

limitinteger

Limit of number of items returned.

page_tokenstring

Page token for pagination.

labelsstring[]

Labels to filter by.

beforestring date-time

Timestamp before which to filter by.

afterstring date-time

Timestamp after which to filter by.

ascendingboolean

Sort in ascending temporal order.

include_spamboolean

Include spam in results.

include_blockedboolean

Include blocked in results.

include_unauthenticatedboolean

Include unauthenticated in results.

include_trashboolean

Include trash in results.

sendersstring[]

Filter to threads whose senders contain this value (substring match). Repeatable; all values must match.

recipientsstring[]

Filter to threads whose recipients contain this value (substring match). Repeatable; all values must match.

subjectstring[]

Filter to threads whose subject contains this value (substring match). Repeatable; all values must match.

Response

Response with status 200

countinteger required

Number of items returned.

limitinteger

Limit of number of items returned.

next_page_tokenstring

Page token for pagination.

Changes

  • 3f5c7830c952Revision changes
    • info

      the endpoint scheme security Bearer was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      api tag threads added

    • info

      api tag Threads removed

  • 394ddcdd9c29Revision changes
    • info

      added the new optional query request parameter recipients

    • info

      added the new optional query request parameter senders

    • info

      added the new optional query request parameter subject

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status