> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt.

# Get Thread

GET https://api.agentmail.to/v0/pods/{pod_id}/threads/{thread_id}

**CLI:**

```bash
agentmail pods threads get --pod-id <pod_id> --thread-id <thread_id>
```

Reference: https://agentmail.to/docs/api-reference/pods/threads/get

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.agentmail.to` (prod, default)
- `https://x402.api.agentmail.to` (prod-x402)
- `https://mpp.api.agentmail.to` (prod-mpp)
- `https://api.agentmail.eu` (eu-prod)

## Request

### Path parameters

- `pod_id` (string, required) — ID of pod.
- `thread_id` (string, required) — ID of thread.

### Query parameters

- `limit` (integer, optional) — Maximum number of messages to return. Cannot exceed 100.
- `page_token` (string, optional) — Token returned by the previous response for retrieving the next, older page.

## Response

### 200

- `inbox_id` (string, required) — The ID of the inbox.
- `thread_id` (string, required) — ID of thread.
- `labels` (list of string, required) — Labels of thread.
- `timestamp` (datetime, required) — Timestamp of last sent or received message.
- `senders` (list of string, required) — Senders in thread. In format `username@domain.com` or `Display Name <username@domain.com>`.
- `recipients` (list of string, required) — Recipients in thread. In format `username@domain.com` or `Display Name <username@domain.com>`.
- `last_message_id` (string, required) — ID of last message in thread.
- `message_count` (integer, required) — Number of messages in thread.
- `size` (integer, required) — Size of thread in bytes.
- `updated_at` (datetime, required) — Time at which thread was last updated.
- `created_at` (datetime, required) — Time at which thread was created.
- `count` (integer, required) — Number of messages in this response page.
- `messages` (list of Message, required) — Messages in this page, ordered by `timestamp` ascending. The first page contains the newest messages; follow `next_page_token` to retrieve older pages.
- `received_timestamp` (datetime, optional) — Timestamp of last received message.
- `sent_timestamp` (datetime, optional) — Timestamp of last sent message.
- `subject` (string, optional) — Subject of thread.
- `preview` (string, optional) — Text preview of last message in thread.
- `attachments` (list of Attachment, optional) — Attachments in thread.
- `limit` (integer, optional) — Maximum number of messages requested for this page.
- `next_page_token` (string, optional) — Token for the next, older page of messages. Omitted when this page completes the thread.

## Errors

### 404 Not Found Error

- `name` (string, required) — Name of error.
- `message` (string, required) — Error message.
- `code` (string, optional) — Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text.
- `fix` (string, optional) — The concrete next action that resolves the error.
- `docs` (string, optional) — Link to the error reference entry for this code.

## Types

### Message

- `inbox_id` (string, required) — The ID of the inbox.
- `thread_id` (string, required) — ID of thread.
- `message_id` (string, required) — ID of message.
- `labels` (list of string, required) — Labels of message.
- `timestamp` (datetime, required) — Time at which message was sent or drafted.
- `from` (string, required) — Address of sender. In format `username@domain.com` or `Display Name <username@domain.com>`.
- `to` (list of string, required) — Addresses of recipients. In format `username@domain.com` or `Display Name <username@domain.com>`.
- `size` (integer, required) — Size of message in bytes.
- `updated_at` (datetime, required) — Time at which message was last updated.
- `created_at` (datetime, required) — Time at which message was created.
- `reply_to` (list of string, optional) — Reply-to addresses. In format `username@domain.com` or `Display Name <username@domain.com>`.
- `cc` (list of string, optional) — Addresses of CC recipients. In format `username@domain.com` or `Display Name <username@domain.com>`.
- `bcc` (list of string, optional) — Addresses of BCC recipients. In format `username@domain.com` or `Display Name <username@domain.com>`.
- `subject` (string, optional) — Subject of message.
- `preview` (string, optional) — Text preview of message.
- `text` (string, optional) — Plain text body of message.
- `html` (string, optional) — HTML body of message.
- `extracted_text` (string, optional) — Extracted new text content.
- `extracted_html` (string, optional) — Extracted new HTML content.
- `attachments` (list of Attachment, optional) — Attachments in message.
- `in_reply_to` (string, optional) — ID of message being replied to.
- `calendar_event_id` (string, optional) — The calendar event this email's invitation was applied to: set when the email's calendar invitation, update, cancellation or attendee reply changed the inbox's calendar, a few seconds after the email arrives. For an email about one date of a recurring event, it is that date's event ID. Absent on other emails, and on invitations that were not imported. Calendar is in AgentMail Labs.
- `references` (list of string, optional) — IDs of previous messages in thread.
- `headers` (map from string to string, optional) — Headers in message.
- `agent_armor` (AgentArmorResult, optional) — Agent Armor's result for this message. Present only on messages received while Agent Armor was on for your organization. A scan starts `pending` and usually completes within seconds. `message.security.completed` is sent only for `complete` results, so a message still `pending` at `deadline_at` reads `unavailable` with no event.

### Attachment

- `attachment_id` (string, required) — ID of attachment.
- `size` (integer, required) — Size of attachment in bytes.
- `filename` (string, optional) — Filename of attachment.
- `content_type` (string, optional) — Content type of attachment.
- `content_disposition` (enum, optional) — Content disposition of attachment.
  - Allowed values: `inline`, `attachment`
- `content_id` (string, optional) — Content ID of attachment.

### AgentArmorResult

Agent Armor's result for this message. Present only on messages received while Agent Armor was on for your organization. A scan starts `pending` and usually completes within seconds. `message.security.completed` is sent only for `complete` results, so a message still `pending` at `deadline_at` reads `unavailable` with no event.

- `status`: `pending`
  - `deadline_at` (datetime, required) — When the scan gives up. A result still pending then reads as `unavailable` with `deadline_exceeded`.
  - `started_at` (datetime, required) — When the message was received. The deadline counts from here.
- `status`: `complete`
  - `completed_at` (datetime, required) — When the scan finished.
  - `model` (string, required) — Identifies the Agent Armor release that produced the verdict. Opaque; it changes when Agent Armor is updated.
  - `reason` (string, required) — A short explanation of the verdict.
  - `verdict` (enum, required) — What the scan concluded. `clear` means Agent Armor found no threat. It is advisory, not a guarantee that the message is safe. `review` means the message may try to manipulate an agent: inspect it before an agent acts on it.
    - Allowed values: `clear`, `review`
  - `manual_override` (AgentArmorManualOverride, optional) — Present on a `review` held in hold mode that someone released.
- `status`: `unavailable`
  - `unavailable_reason` (enum, required) — Why no verdict is available.
    - Allowed values: `unsupported_dsn`, `payload_too_large`, `no_scannable_content`, `enqueue_failed`, `scorer_failed`, `contract_error`, `deadline_exceeded`

### AgentArmorManualOverride

The record of a release of a message Agent Armor held for review.

- `override_id` (string, required) — ID of the release, and the `event_id` of its `message.security.override` event.
- `actor` (AgentArmorReleaseActor, required) — Who released the message.
- `reason` (string, required) — Why it was released, as given by whoever released it.
- `original_verdict` ("review", required) — The verdict that held the message.
- `released_at` (datetime, required) — When it was released.

### AgentArmorReleaseActor

Who released the message.

- `kind`: `api_key`
  - `api_key_id` (string, required) — The API key that released it.
- `kind`: `console`

## Examples

**Response**

```json
{
  "inbox_id": "inbox_id",
  "thread_id": "thread_id",
  "labels": [
    "labels",
    "labels"
  ],
  "timestamp": "2024-01-15T09:30:00Z",
  "senders": [
    "senders",
    "senders"
  ],
  "recipients": [
    "recipients",
    "recipients"
  ],
  "last_message_id": "last_message_id",
  "message_count": 1,
  "size": 1,
  "updated_at": "2024-01-15T09:30:00Z",
  "created_at": "2024-01-15T09:30:00Z",
  "count": 1,
  "messages": [
    {
      "inbox_id": "inbox_id",
      "thread_id": "thread_id",
      "message_id": "message_id",
      "labels": [
        "labels",
        "labels"
      ],
      "timestamp": "2024-01-15T09:30:00Z",
      "from": "from",
      "to": [
        "to",
        "to"
      ],
      "size": 1,
      "updated_at": "2024-01-15T09:30:00Z",
      "created_at": "2024-01-15T09:30:00Z",
      "reply_to": [
        "reply_to",
        "reply_to"
      ],
      "cc": [
        "cc",
        "cc"
      ],
      "bcc": [
        "bcc",
        "bcc"
      ],
      "subject": "subject",
      "preview": "preview",
      "text": "text",
      "html": "html",
      "extracted_text": "extracted_text",
      "extracted_html": "extracted_html",
      "attachments": [
        {
          "attachment_id": "attachment_id",
          "size": 1,
          "filename": "filename",
          "content_type": "content_type",
          "content_disposition": "inline",
          "content_id": "content_id"
        },
        {
          "attachment_id": "attachment_id",
          "size": 1,
          "filename": "filename",
          "content_type": "content_type",
          "content_disposition": "inline",
          "content_id": "content_id"
        }
      ],
      "in_reply_to": "in_reply_to",
      "calendar_event_id": "calendar_event_id",
      "references": [
        "references",
        "references"
      ],
      "headers": {
        "headers": "headers"
      },
      "agent_armor": {
        "status": "pending",
        "deadline_at": "2024-01-15T09:30:00Z",
        "started_at": "2024-01-15T09:30:00Z"
      }
    },
    {
      "inbox_id": "inbox_id",
      "thread_id": "thread_id",
      "message_id": "message_id",
      "labels": [
        "labels",
        "labels"
      ],
      "timestamp": "2024-01-15T09:30:00Z",
      "from": "from",
      "to": [
        "to",
        "to"
      ],
      "size": 1,
      "updated_at": "2024-01-15T09:30:00Z",
      "created_at": "2024-01-15T09:30:00Z",
      "reply_to": [
        "reply_to",
        "reply_to"
      ],
      "cc": [
        "cc",
        "cc"
      ],
      "bcc": [
        "bcc",
        "bcc"
      ],
      "subject": "subject",
      "preview": "preview",
      "text": "text",
      "html": "html",
      "extracted_text": "extracted_text",
      "extracted_html": "extracted_html",
      "attachments": [
        {
          "attachment_id": "attachment_id",
          "size": 1,
          "filename": "filename",
          "content_type": "content_type",
          "content_disposition": "inline",
          "content_id": "content_id"
        },
        {
          "attachment_id": "attachment_id",
          "size": 1,
          "filename": "filename",
          "content_type": "content_type",
          "content_disposition": "inline",
          "content_id": "content_id"
        }
      ],
      "in_reply_to": "in_reply_to",
      "calendar_event_id": "calendar_event_id",
      "references": [
        "references",
        "references"
      ],
      "headers": {
        "headers": "headers"
      },
      "agent_armor": {
        "status": "pending",
        "deadline_at": "2024-01-15T09:30:00Z",
        "started_at": "2024-01-15T09:30:00Z"
      }
    }
  ],
  "received_timestamp": "2024-01-15T09:30:00Z",
  "sent_timestamp": "2024-01-15T09:30:00Z",
  "subject": "subject",
  "preview": "preview",
  "attachments": [
    {
      "attachment_id": "attachment_id",
      "size": 1,
      "filename": "filename",
      "content_type": "content_type",
      "content_disposition": "inline",
      "content_id": "content_id"
    },
    {
      "attachment_id": "attachment_id",
      "size": 1,
      "filename": "filename",
      "content_type": "content_type",
      "content_disposition": "inline",
      "content_id": "content_id"
    }
  ],
  "limit": 1,
  "next_page_token": "next_page_token"
}
```

**SDK Code**

```python
import requests

url = "https://api.agentmail.to/v0/pods/pod_id/threads/thread_id"

headers = {"Authorization": "Bearer <api_key>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.agentmail.to/v0/pods/pod_id/threads/thread_id';
const options = {method: 'GET', headers: {Authorization: 'Bearer <api_key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agentmail.to/v0/pods/pod_id/threads/thread_id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <api_key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.agentmail.to/v0/pods/pod_id/threads/thread_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <api_key>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.agentmail.to/v0/pods/pod_id/threads/thread_id")
  .header("Authorization", "Bearer <api_key>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.agentmail.to/v0/pods/pod_id/threads/thread_id', [
  'headers' => [
    'Authorization' => 'Bearer <api_key>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.agentmail.to/v0/pods/pod_id/threads/thread_id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <api_key>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <api_key>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentmail.to/v0/pods/pod_id/threads/thread_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```