Get a thread

GET /api/v1/accounts/{accountId}/threads/{threadId}

Get a complete email thread by its provider ID.

Authentication

Pass a Fluxmail API key as a bearer token. The key determines the member, mailbox scope, and permissions for the request.

Request

curl 'http://localhost:8977/api/v1/accounts/acct_123/threads/thread_123' \
  -H "Authorization: Bearer $FLUXMAIL_API_KEY"

Parameters

Name	Location	Required	Type	Details
`accountId`	path	Yes	`string`	Minimum length: 1.
`threadId`	path	Yes	`string`	Minimum length: 1.

Responses

Status	Description	Content type
`200`	Thread	`application/json`
`400`	Invalid request	`application/json`
`401`	Authentication required	`application/json`
`403`	Permission or plan denied	`application/json`
`404`	Resource not found	`application/json`
`409`	Request conflict	`application/json`
`422`	Unsupported capability	`application/json`
`429`	Provider rate limit	`application/json`
`500`	Internal error	`application/json`
`503`	Provider unavailable	`application/json`

200 response

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "subject": {
          "type": "string"
        },
        "messages": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "threadId": {
                "type": "string"
              },
              "accountId": {
                "type": "string"
              },
              "draftId": {
                "type": "string"
              },
              "folder": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "role": {
                    "type": "string",
                    "enum": [
                      "inbox",
                      "sent",
                      "drafts",
                      "trash",
                      "spam",
                      "archive",
                      "starred",
                      "all"
                    ]
                  },
                  "roleSource": {
                    "type": "string",
                    "enum": [
                      "user",
                      "extension",
                      "name"
                    ]
                  },
                  "unreadCount": {
                    "type": "integer",
                    "minimum": 0
                  }
                },
                "required": [
                  "id",
                  "name"
                ],
                "additionalProperties": false
              },
              "labels": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "from": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email"
                  },
                  "name": {
                    "type": "string",
                    "minLength": 1
                  }
                },
                "required": [
                  "email"
                ],
                "additionalProperties": false
              },
              "to": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "email": {
                      "type": "string",
                      "format": "email"
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1
                    }
                  },
                  "required": [
                    "email"
                  ],
                  "additionalProperties": false
                }
              },
              "cc": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "email": {
                      "type": "string",
                      "format": "email"
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1
                    }
                  },
                  "required": [
                    "email"
                  ],
                  "additionalProperties": false
                }
              },
              "bcc": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "email": {
                      "type": "string",
                      "format": "email"
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1
                    }
                  },
                  "required": [
                    "email"
                  ],
                  "additionalProperties": false
                }
              },
              "replyTo": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "email": {
                      "type": "string",
                      "format": "email"
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1
                    }
                  },
                  "required": [
                    "email"
                  ],
                  "additionalProperties": false
                }
              },
              "subject": {
                "type": "string"
              },
              "date": {
                "type": "string"
              },
              "snippet": {
                "type": "string"
              },
              "body": {
                "type": "object",
                "properties": {
                  "text": {
                    "type": "string"
                  },
                  "html": {
                    "type": "string"
                  }
                },
                "additionalProperties": false
              },
              "attachments": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "filename": {
                      "type": "string"
                    },
                    "mimeType": {
                      "type": "string"
                    },
                    "sizeBytes": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "contentId": {
                      "type": "string"
                    },
                    "disposition": {
                      "type": "string",
                      "enum": [
                        "inline",
                        "attachment"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "filename",
                    "mimeType",
                    "sizeBytes"
                  ],
                  "additionalProperties": false
                }
              },
              "flags": {
                "type": "object",
                "properties": {
                  "read": {
                    "type": "boolean"
                  },
                  "starred": {
                    "type": "boolean"
                  },
                  "draft": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "read",
                  "starred",
                  "draft"
                ],
                "additionalProperties": false
              },
              "headers": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                }
              }
            },
            "required": [
              "id",
              "threadId",
              "accountId",
              "to",
              "subject",
              "date",
              "flags"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "id",
        "subject",
        "messages"
      ],
      "additionalProperties": false
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}