Legacy Mailbox API 1.0 is deprecated
Legacy Mailbox API 1.0 was deprecated on November 20, 2019. Please use Mailbox API 2.0 going forward. If you have any questions or need help with the new API, please reach out.
The following fields are returned when listing conversations.
The type of conversation.
|folderId||Int||1234||ID of the Mailbox Folder to which this conversation resides.|
|number||Int||349||The conversation number displayed in the UI. This number can be used in combination with the
|owner||Person||The Help Scout user who is currently assigned to this conversation.|
|mailbox||MailboxRef||MailboxRef to which this conversation belongs.|
|customer||Person||The customer who this conversation is associated with.|
|threadCount||Int||4||This count represents the number of published threads found on the conversation (it does not include line items, drafts or threads held for review by Collision Detection).|
|status||String||active||Status of the conversation. Possible values include:
|subject||String||I need help!|
|preview||String||Hello, I tried to download the file off your site...|
|createdBy||Person||The Person who created this conversation. The 'type' property will specify whether it was created by a 'user' or a 'customer'.|
|createdAt||Datetime||2012-07-23T12:34:12Z||UTC time when this conversation was created.|
|modifiedAt or userModifiedAt||Datetime||2012-07-24T20:18:33Z||UTC time when a user last modified this conversation.|
|closedAt||Datetime||UTC time when this conversation was closed. Null if not closed|
|closedBy||Person||The Help Scout user who closed this conversation.|
|source||Source||Specifies the method in which this conversation was created.|
|cc||Collection||Collection of strings representing email addresses|
|bcc||Collection||Collection of strings representing email addresses|
|tags||Collection||Collection of strings|
In addition to the fields above, the following fields are returned when retrieving a single Conversation.
|threads||Collection||Collection of Thread objects|
|customFields||Collection||Collection of Field objects; only included for Plus Plan accounts|