API ReferencePodsThreads

List Threads

Lists threads in the pod, 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, use `Search Threads`. **CLI:** ```bash agentmail pods:threads list --pod-id <pod_id> ```

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

pod_idstringRequired
ID of pod.

Query parameters

limitintegerOptional
Limit of number of items returned.
page_tokenstringOptional
Page token for pagination.
labelslist of stringsOptional
Labels to filter by.
beforedatetimeOptional
Timestamp before which to filter by.
afterdatetimeOptional
Timestamp after which to filter by.
ascendingbooleanOptional
Sort in ascending temporal order.
include_spambooleanOptional
Include spam in results.
include_blockedbooleanOptional
Include blocked in results.
include_unauthenticatedbooleanOptional
Include unauthenticated in results.
include_trashbooleanOptional
Include trash in results.
senderslist of stringsOptional

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

recipientslist of stringsOptional

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

subjectlist of stringsOptional

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

Response

This endpoint returns an object.
countinteger
Number of items returned.
threadslist of objects

Ordered by timestamp descending.

limitinteger
Limit of number of items returned.
next_page_tokenstring
Page token for pagination.

Errors

404
Not Found Error