List conversations

get https://api2.frontapp.com/conversations

List the conversations in the company in reverse chronological order (most recently updated first). The order will respect your company's bump settings, which determine when conversations bump to the top. For more advanced filtering, see the search endpoint.

Response

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 conversation

subject

string

Subject of the message for email message

status

string

Status of the conversation

archived unassigned deleted assigned

status_id

string

Unique identifier of the conversation status category, only present if ticketing is enabled

status_category

string

Status category of the conversation

open waiting resolved

ticket_ids

array of strings

List of ticket ids associated with the conversation

ticket_ids

assignee

object

Partial representation of the teammate assigned to the conversation

recipient

object

Main recipient of the conversation

tags

object

_links

object

string

Unique identifier of the tag

name

string

Name of the tag

description

string

Description of the tag

highlight

string

Highlight color of the tag.

grey pink red orange yellow green light-blue blue purple

is_private

boolean

Whether or not the tag is individual

is_visible_in_conversation_lists

boolean

Whether the tag is visible in conversation lists.

created_at

number

Timestamp of tag create creation

updated_at

number

Timestamp of the last tag update

links

array of objects

List of the links for this conversation

links

object

_links

object

string

Unique identifier of the link

name

string

Display name of the link

type

string

Type of the link. Typically associated with the underlying link provider (if known)

external_url

string

Underlying identifying external URL of the link

custom_fields

object

Custom fields for this link

Has additional fields

custom_fields

object

Custom fields for this conversation

Has additional fields

created_at

number

Timestamp at which the conversation have been created.

waiting_since

number

Timestamp of the oldest unreplied message.

is_private

boolean

Whether or not the conversation is private

scheduled_reminders

array of objects

List of scheduled (non-expired and non-canceled) reminders for this conversation

scheduled_reminders

object

_links

object

created_at

number

Timestamp at which the conversation reminder has been created

scheduled_at

number

Timestamp that the conversation reminder has been scheduled for

updated_at

number

Timestamp at which the conversation reminder has been updated

metadata

object

Optional metadata about the conversation

Language

Credentials

Bearer

JWT


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

Choose an example:

application/json

200Array of conversations