Zoom Public API Documentation
Get the specified email thread
GET {{baseUrl}}/emails/mailboxes/:email/threads/:threadId?format=full&metadataHeaders=<string>&maxResults=<string>&pageToken=<string>
Retrieves the specified thread. Scopes: Rate Limit Label: Not supported in Gov cluster mail:readLIGHT
Body
PARAM
| Key | Datatype | Required | Description |
format
|
string | The format to return the messages in. | |
metadataHeaders
|
string | When requested format is metadata, only include headers specified in this query parameter. | |
maxResults
|
string | Maximum number of thread messages to return. This field defaults to 50. The maximum allowed value for this field is 500. | |
pageToken
|
string | Page token to retrieve a specific page of results in the list. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"id": "<string>",
"historyId": "<string>",
"threadName": "<string>",
"status": "ignored",
"messages": [
{
"id": "<string>",
"threadId": "<string>",
"labelIds": [
"<string>",
"<string>"
],
"historyId": "<string>",
"internalDate": "<string>",
"expiration": "<string>",
"lastMoved": "<string>",
"payload": {
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"size": "<integer>",
"data": "<string>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
}
]
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
}
]
}
]
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
}
]
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
}
]
}
]
}
]
},
"snippet": "<string>",
"sendTime": "<string>",
"userScheduled": "<boolean>",
"sizeEstimate": "<string>"
},
{
"id": "<string>",
"threadId": "<string>",
"labelIds": [
"<string>",
"<string>"
],
"historyId": "<string>",
"internalDate": "<string>",
"expiration": "<string>",
"lastMoved": "<string>",
"payload": {
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"size": "<integer>",
"data": "<string>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
}
]
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
}
]
}
]
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
}
]
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
},
"parts": [
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
},
{
"partId": "<string>",
"mimeType": "<string>",
"filename": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
],
"body": {
"attachmentId": "<string>",
"data": "<string>",
"size": "<integer>"
}
}
]
}
]
}
]
},
"snippet": "<string>",
"sendTime": "<string>",
"userScheduled": "<boolean>",
"sizeEstimate": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/emails/mailboxes/:email/threads/:threadId?format=full&metadataHeaders=<string>&maxResults=<string>&pageToken=<string>?format=full&metadataHeaders=<string>&maxResults=<string>&pageToken=<string>' -H 'Accept: application/json'
ENDPOINTS