inboxes > threads

CLI:

agentmail inboxes threads get --inbox-id <inbox_id> --thread-id <thread_id>
get/v0/inboxes/{inbox_id}/threads/{thread_id}

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/inboxes/{inbox_id}/threads/{thread_id}
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

The ID of the inbox.

thread_idstring required

ID of thread.

Query parameters

limitinteger

Limit of number of items returned.

Maximum number of messages to return. Cannot exceed 100.

page_tokenstring

Page token for pagination.

Token returned by the previous response for retrieving the next, older page.

Response

Response with status 200

inbox_idstring required

The ID of the inbox.

thread_idstring required

ID of thread.

labelsstring[] required

Labels of thread.

timestampstring date-time required

Timestamp of last sent or received message.

received_timestampstring date-time

Timestamp of last received message.

sent_timestampstring date-time

Timestamp of last sent message.

sendersstring[] required

Senders in thread. In format username@domain.com or Display Name <username@domain.com>.

recipientsstring[] required

Recipients in thread. In format username@domain.com or Display Name <username@domain.com>.

subjectstring

Subject of thread.

previewstring

Text preview of last message in thread.

last_message_idstring required

ID of last message in thread.

message_countinteger required

Number of messages in thread.

sizeinteger required

Size of thread in bytes.

updated_atstring date-time required

Time at which thread was last updated.

created_atstring date-time required

Time at which thread was created.

countinteger required

Number of items returned.

limitinteger

Limit of number of items returned.

next_page_tokenstring

Page token for pagination.

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 inboxes > threads added

    • info

      api tag InboxesThreads removed

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter page_token

    • 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

    • 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 required 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

    • info

      added the optional property to the response with the status