Core API

Introduction
Response Body Structure
API Terminology 101
Accounts
Analytics
Applications
- Trigger application eventpost
Attachments
Channels
Comments
Contacts
Contact Groups
Contact Handles
- Add contact handlepost
- Delete contact handledelete
Contact Lists
Contact Notes
- List notesget
- Add notepost
Conversations
Custom Fields
Drafts
Events
- List eventsget
- Get eventget
Inboxes
Knowledge Bases
Links
Rules
Messages
Message Templates
Message Template Folders
Shifts
Signatures
Statuses
- List company ticket statusesget
- Get ticket statusget
Tags
Token Identity
- API Token detailsget
Teammates
Teammate groups
Teams / Workspaces

Plugin SDK

Introduction
- Installation
- Plugin Terminology 101
Getting events from Front
- Front.contextUpdates
Context API
Utility Functions
Data models
FAQ

Channel API

Introduction
FAQ
API endpoints

List conversation messages

get https://api2.frontapp.com/conversations/{conversation_id}/messages

List the messages in a conversation in reverse chronological order (newest first).

Path Params

conversation_id

string

required

Defaults to cnv_123

The conversation ID

Query Params

limit

integer

≤ 100

Max number of results per page

page_token

string

Token to use to request the next page

sort_by

string

Field used to sort the messages. Only supports created_at.

sort_order

string

Order by which results should be sorted

Responses

Response body

object

_pagination

object

string | null

Link to next page of results

_links

object

self

string

Link to resource

_results

array of objects

_results

object

_links

object

string

Unique identifier of the message

message_uid

string

Secondary unique identifier of a message. Generated by Front on message creation. Learn more at about the message UID.

type

string

Type of the message

call custom email facebook front_chat googleplay intercom internal phone-call sms tweet tweet_dm whatsapp yalo_wha

is_inbound

boolean

Whether or not the message has been received or sent

draft_mode

string | null

If the message is a draft, describes the draft mode. Can be 'private' (draft is visible to the author only) or 'shared' (draft is visible to all teammates with access to the conversation).

shared private

error_type

string

Type of the error when the draft failed to be sent

version

string

The current version of the message in Front

created_at

number

Date at which the message as been sent or received

subject

string

Subject of the message

blurb

string

Preview of the message body

author

object

Front teammate who sent this message

recipients

array of objects

recipients

object

_links

object

name

string

Name of the recipient.

handle

string

Handle of the contact. Can be any string used to uniquely identify the contact

role

string

Role of the recipient

from to cc bcc

body

string

Body of the message

text

string

Text version of the body for email messages

attachments

array of objects

List of files attached to the message

attachments

object

string

The unique identifier of the attachment.

filename

string

Name of the attached file

url

string

URL to download the attached file

content_type

string

Content type of the attached file in MIME format. Note that some attachments types may not be supported.

size

integer

Size (in byte) of the attached file

metadata

object

Attachment metadata

signature

object

The signature attached to this message

metadata

object

Optional metadata about the message

301

If the conversation has been merged, the response redirects you to the merged conversation.

Updated 23 days ago

Remove conversation links

Update conversation reminders

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api2.frontapp.com/conversations/cnv_123/messages \
3
     --header 'accept: application/json'

Choose an example:

application/json

Updated 23 days ago

Remove conversation links

Update conversation reminders

Core API
Introduction
Response Body Structure
API Terminology 101
Accounts
Remove contact from Accountdelete
Add contact to Accountpost
List account contactsget
Delete an accountdelete
Update accountpatch
Fetch an accountget
Create accountpost
List Accountsget
Analytics
Fetch an analytics reportget
Create a new analytics reportpost
Fetch an analytics exportget
Create a new analytics exportpost
Applications
Trigger application eventpost
Attachments
Download attachment for a messageget
Download attachment for a message templateget
Download attachmentget
Download attachment for a commentget
Channels
List team channelsget
List teammate channelsget
Create a channelpost
Validate channelpost
Update Channelpatch
Get channelget
List channelsget
Comments
Add comment replypost
Add commentpost
List conversation commentsget
List comment mentionsget
Update commentpatch
Get commentget
Contacts
Create team contactpost
List team contactsget
Create teammate contactpost
List teammate contactsget
List contact conversationsget
Delete a contactdelete
Update a contactpatch
Get contactget
Merge contactspost
Create contactpost
List contactsget
Contact Groups
Create team grouppost
List team groupsget
Create teammate grouppost
List teammate groupsget
Remove contacts from groupdelete
Add contacts to grouppost
List contacts in groupget
Delete groupdelete
Create grouppost
List groupsget
Contact Handles
Delete contact handledelete
Add contact handlepost
Contact Lists
Create team contact listpost
List team contact listsget
Create teammate contact listpost
List teammate contact listsget
Remove contacts from contact listdelete
Add contacts to contact listpost
List contacts in contact listget
Delete contact listdelete
Create contact listpost
List contact listsget
Contact Notes
Add notepost
List notesget
Conversations
Remove conversation tagdelete
Add conversation tagpost
Update conversation reminderspatch
List conversation messagesget
Remove conversation linksdelete
Add conversation linkpost
List conversation inboxesget
Delete conversation followersdelete
Add conversation followerspost
List conversation followersget
List conversation eventsget
Update conversation assigneeput
Update conversationpatch
Get conversationget
Search conversationsget
Create discussion conversationpost
List conversationsget
Custom Fields
List Teammate's custom fieldsget
List Link's custom fieldsget
List Inbox's custom fieldsget
List Contact's custom fieldsget
List Conversation's custom fieldsget
List Contact's custom fieldsget
List Account's custom fieldsget
Drafts
Edit draftpatch
Delete draftdelete
Create draft replypost
List conversation draftsget
Create draftpost
Events
Get eventget
List eventsget
Inboxes
Create team inboxpost
List team inboxesget
Removes inbox accessdelete
Add inbox accesspost
List inbox accessget
List inbox conversationsget
List inbox channelsget
Get inboxget
Create inboxpost
List inboxesget
Knowledge Bases
Knowledge Base Categories
Create knowledge base category in specified localepost
List articles in a categoryget
Update knowledge base category in specified localepatch
Create knowledge base category in default localepost
Get knowledge base category with content in specified localeget
Update knowledge base category in default localepatch
Get knowledge base category content in default localeget
Delete a knowledge base categorydelete
Get a knowledge base categoryget
Knowledge Base Articles
Create article in a knowledge base in specified localepost
Update article content in specified localepatch
Get knowledge base article with content in specified localeget
Download attachment from an articleget
Create article in a knowledge base in default localepost
Update article content in default locale.patch
Get knowledge base article with content in default localeget
Delete an articledelete
Get a knowledge base articleget
Update knowledge base in specified localepatch
Get a knowledge base with content in specified localeget
List articles in a knowledge baseget
Update knowledge base in default localepatch
List categories in a knowledge baseget
Get a knowledge base with content in default localeget
Get a knowledge baseget
Create a knowledge basepost
List knowledge basesget
Links
List link conversationsget
Update a linkpatch
Get linkget
Create linkpost
List linksget
Rules
List team rulesget
List teammate rulesget
Get ruleget
List rulesget
List all company rulesget
Messages
Mark message seenpost
Get message seen statusget
Get messageget
Import messagepost
Create message replypost
Create messagepost
Receive custom messagespost
Message Templates
Create team message templatepost
List team message templatesget
Create teammate message templatepost
List teammate message templatesget
Delete message templatedelete
Update message templatepatch
Get message templateget
Create message templatepost
List message templatesget
Create child templatepost
Get child templatesget
Message Template Folders
Create team folderpost
List team foldersget
Create teammate folderpost
List teammate foldersget
Create child folderpost
Get child foldersget
Delete folderdelete
Update folderpatch
Get folderget
Create folderpost
List foldersget
Shifts
Create team shiftpost
List team Shiftsget
List Teammate Shiftsget
Update shiftpatch
Create shiftpost
List Shiftsget
Remove teammates from shiftdelete
Add teammates to shiftpost
List shift's teammatesget
Get shiftget
Signatures
Create team signaturepost
List team signaturesget
Create teammate signaturepost
List teammate signaturesget
Delete signaturedelete
Update signaturepatch
Get signaturesget
Statuses
Get ticket statusget
List company ticket statusesget
Tags
Create team tagpost
List team tagsget
Create teammate tagpost
List teammate tagsget
List tagged conversationsget
Create child tagpost
List tag childrenget
Delete tagdelete
Update a tagpatch
Get tagget
Create tagpost
List tagsget
Create company tagpost
List company tagsget
Token Identity
API Token detailsget
Teammates
List teammate inboxesget
List assigned conversationsget
Update teammatepatch
Get teammateget
List teammatesget
Teammate groups
Remove teammate group teamsdelete
Add teammate group teamspost
List teammate group teamsget
Remove teammate group teammatesdelete
Add teammate group teammatespost
List teammate group teammatesget
Remove teammate group team inboxesdelete
Add teammate group team inboxespost
List teammate group team inboxesget
Delete teammate groupdelete
Update a teammate grouppatch
Get teammate groupget
Create teammate grouppost
List teammate groupsget
Teams / Workspaces
Remove teammates from teamdelete
Add teammates to teampost
Get teamget
List teamsget

Plugin SDK
Introduction
Plugin Terminology 101
Installation
Getting events from Front
Front.contextUpdates
Context API
updateDraft
untag
tag
setStatus
search
removeLink
openUrlInPopup
openUrl
openConversationInPopup
move
listTicketStatuses
listTeammates
listTags
listRecipients
listMessages
listInboxes
listComments
listChannels
fetchPath
fetchDraft
downloadComposerAttachment
downloadAttachment
createDraft
closeDraft
close
assign
addTopic
addLink
Utility Functions
delegateNewWindowsToFront
delegateAnchorClicksToFront
isCancelError
buildCancelTokenSource
Data models
Topic
TicketStatus
Teammate
Tag
Recipient
PaginationToken
Message
Link
Inbox
Draft message
CustomField
Conversation
Context
EntryPoint
Contact
Comment
Channel
CancelToken
Attachment

Channel API
Introduction
API endpoints
Update external message statusput
Update Channelpatch
Sync outbound messagepost
Sync inbound messagepost

200Array of messages