Front Comments API
Add, list, and remove internal comments on conversations for collaboration.
OpenAPI Specification
{
"openapi": "3.0.0",
"x-api-id": "front",
"x-explorer-enabled": false,
"x-proxy-enabled": true,
"x-samples-enabled": true,
"info": {
"version": "1.0.0",
"title": "Core API",
"contact": {
"name": "Front Platform",
"url": "https://community.front.com"
}
},
"security": [
{
"http": []
}
],
"servers": [
{
"url": "https://api2.frontapp.com"
}
],
"components": {
"schemas": {
"Account": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Account"
},
"description": {
"type": "string",
"description": "Account description"
},
"domains": {
"type": "array",
"description": "List of domains associated with the Account",
"items": {
"type": "string"
}
},
"external_id": {
"type": "string",
"description": "ID of the Account in an external system"
},
"custom_fields": {
"description": "Custom fields for this account",
"$ref": "#/components/schemas/CustomFieldParameter"
}
}
},
"AccountIds": {
"type": "object",
"required": [
"account_ids"
],
"properties": {
"account_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceID"
}
}
}
},
"AccountPatch": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Account"
},
"description": {
"type": "string",
"description": "Account description"
},
"domains": {
"type": "array",
"description": "List of domains associated with the Account",
"items": {
"type": "string"
}
},
"custom_fields": {
"description": "Custom fields for this account. If you want to keep all custom fields the same when updating this resource, do not include any custom fields in the update. If you want to update custom fields, make sure to include all custom fields, not just the fields you want to add or update. If you send only the custom fields you want to update, the other custom fields will be erased. You can retrieve the existing custom fields before making the update to note the current fields.",
"$ref": "#/components/schemas/CustomFieldParameter"
}
}
},
"AccountResponse": {
"type": "object",
"required": [
"_links",
"id",
"name",
"logo_url",
"description",
"domains",
"external_id",
"custom_fields"
],
"properties": {
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to resource",
"example": "https://yourCompany.api.frontapp.com/accounts/acc_76"
},
"related": {
"type": "object",
"properties": {
"contacts": {
"type": "string",
"description": "Link to contacts associated to the account",
"example": "https://yourCompany.api.frontapp.com/accounts/acc_76/contacts"
}
}
}
}
},
"id": {
"type": "string",
"description": "Unique identifier of the account",
"example": "acc_76"
},
"name": {
"type": "string",
"description": "Account name",
"example": "Dunder Mifflin, Inc."
},
"logo_url": {
"type": "string",
"nullable": true,
"description": "URL of the Account's logo",
"example": "https://yourCompany.api.frontapp.com/accounts/acc_aq/logo-1654309308278"
},
"description": {
"type": "string",
"nullable": true,
"description": "Account Description",
"example": "Limitless Paper in a Paperless World"
},
"domains": {
"type": "array",
"description": "List of domains associated to the Account",
"items": {
"type": "string",
"example": [
"dundermifflininc.com",
"limitlesspaper.com"
]
}
},
"external_id": {
"type": "string",
"nullable": true,
"description": "ID of the Account in an External system, such as your backoffice system or CRM",
"example": 8739674733
},
"custom_fields": {
"description": "Custom fields for this account",
"$ref": "#/components/schemas/CustomFieldParameter"
},
"created_at": {
"type": "number",
"description": "Timestamp when the account was created",
"example": 1622672452.363
},
"updated_at": {
"type": "number",
"description": "Timestamp when the account was updated",
"example": 1654309308.278
}
}
},
"AddContactsToList": {
"required": [
"contact_ids"
],
"properties": {
"contact_ids": {
"type": "array",
"description": "List of IDs of the contacts to add in the requested contact list. Alternatively, you can supply the contact source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1).",
"items": {
"$ref": "#/components/schemas/ResourceID"
}
}
}
},
"AnalyticsActivitiesColumns": {
"type": "string",
"enum": [
"Activity ID",
"Type",
"Source",
"Message ID",
"Segment ID",
"Conversation ID",
"Ticket IDs",
"Segment",
"Segment start",
"Segment end",
"Direction",
"Status",
"Status at activity time",
"Inbox",
"Inbox API ID",
"Inbox at activity time",
"Inbox API IDs at activity time",
"Previous inbox IDs",
"Message date",
"Autoreply",
"Reaction time",
"Total reply time",
"Handle time",
"Response time",
"Stage resolution time",
"Replies to resolution",
"Ticket resolution time",
"Ticket replies to resolution",
"Attributed to",
"Assignee",
"Author",
"Contact name",
"Contact handle",
"Account names",
"From",
"To",
"Cc",
"Bcc",
"Extract",
"Tags",
"Tag API IDs",
"Tags at activity time",
"Tag API IDs at activity time",
"Tag application duration",
"Activity API ID",
"Message API ID",
"Comment API ID",
"Conversation API ID",
"Message original ID",
"New Conversation",
"First response",
"Business hours",
"Subject",
"Account name",
"Survey rating",
"Survey comment",
"Segment closed",
"Segment contains messages",
"Last segment activity",
"Added tag",
"Added tag API ID",
"Removed tag",
"Removed tag API ID",
"Segment cumulative teammates",
"Ticket status name",
"Ticket status category",
"Time spent in Ticket Status",
"Transitions to Ticket Status",
"Smart QA score",
"Custom Field",
"Updated Custom Field"
]
},
"AnalyticsActivitiesExportsColumns": {
"required": [
"columns"
],
"type": "object",
"properties": {
"columns": {
"type": "array",
"description": "List of the columns to include in the export. In addition to the\npredefined columns, you can also include parameterized columns by\nappending the parameter value to the column name, separated by a\ncolon (`:`). List of supported prefixes:\n - `Time spent in Ticket Status` (e.g., \"Time spent in Ticket Status:123\", where 123 is the ticket status tag ID)\n - `Transitions to Ticket Status` (e.g., \"Transitions to Ticket Status:123\", where 123 is the ticket status tag ID)\n - `Smart QA score` (e.g., \"Smart QA score:Comprehension\", where \"Comprehension\" is the Smart QA criteria ID)\n - `Custom Field` (e.g., \"Custom Field:456\", where 456 is the custom field ID)\n - `Updated Custom Field` (e.g., \"Updated Custom Field:456\", where 456 is the custom field ID)\n\nExample: `[\"Message ID\", \"Time spent in Ticket Status:123\", \"Smart QA score:Comprehension\"]`\n",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AnalyticsActivitiesColumns"
},
{
"$ref": "#/components/schemas/AnalyticsActivitiesParameterizedColumns"
}
]
},
"default": [
"Activity ID",
"Type",
"Source",
"Message ID",
"Segment ID",
"Conversation ID",
"Ticket IDs",
"Segment",
"Segment start",
"Segment end",
"Direction",
"Status",
"Status at activity time",
"Inbox",
"Inbox API ID",
"Inbox at activity time",
"Inbox API IDs at activity time",
"Previous inbox IDs",
"Message date",
"Autoreply",
"Reaction time",
"Total reply time",
"Handle time",
"Response time",
"Ticket resolution time",
"Ticket replies to resolution",
"Attributed to",
"Assignee",
"Author",
"Contact name",
"Contact handle",
"Account names",
"From",
"To",
"Cc",
"Bcc",
"Extract",
"Tags",
"Tag API IDs",
"Tags at activity time",
"Tag API IDs at activity time",
"Tag application duration",
"Activity API ID",
"Message API ID",
"Comment API ID",
"Conversation API ID",
"Message original ID",
"New Conversation",
"First response",
"Business hours",
"Subject",
"Account name",
"Survey rating",
"Survey comment",
"Segment closed",
"Segment contains messages",
"Last segment activity",
"Added tag",
"Added tag API ID",
"Removed tag",
"Removed tag API ID",
"Segment cumulative teammates"
]
}
}
},
"AnalyticsActivitiesParameterizedColumns": {
"type": "string",
"oneOf": [
{
"type": "string",
"pattern": "^Time spent in Ticket Status:\\d+$"
},
{
"type": "string",
"pattern": "^Transitions to Ticket Status:\\d+$"
},
{
"type": "string",
"pattern": "^Smart QA score:\\w+$"
},
{
"type": "string",
"pattern": "^Custom Field:\\d+$"
},
{
"type": "string",
"pattern": "^Updated Custom Field:\\d+$"
}
]
},
"AnalyticsActivitiesSmartQAScoreParameters": {
"type": "string",
"enum": [
"Comprehension",
"Solution_Offered",
"Professionalism",
"Professional_Behavior",
"Professional_Relationship",
"Readability",
"Grammar_Spelling",
"General_Empathy",
"Cognitive_Empathy",
"Emotional_Empathy",
"Compassionate_Empathy",
"Tone",
"Adaptive_Tone",
"Neutral_Tone",
"Positive_Tone",
"Brevity",
"Demo_Offered",
"Information_Gathering",
"Upsell",
"Friendly",
"Greeting_Offered",
"Personalisation",
"Adaptability"
]
},
"AnalyticsExportRequest": {
"discriminator": {
"propertyName": "type",
"mapping": {
"messages": "#/components/schemas/AnalyticsMessagesExportColumns",
"events": "#/components/schemas/AnalyticsActivitiesExportsColumns"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/AnalyticsMessagesExportColumns"
},
{
"$ref": "#/components/schemas/AnalyticsActivitiesExportsColumns"
}
],
"properties": {
"type": {
"type": "string",
"description": "The type of export to create. The type you specify determines which columns are available for the export.",
"enum": [
"messages",
"events"
]
},
"start": {
"type": "number",
"description": "Start time of the data to include in the export (seconds since 1970-01-01T00:00:00+00). Will be rounded down to the start of the day."
},
"end": {
"type": "number",
"description": "End time of the data to include in the export (seconds since 1970-01-01T00:00:00+00). Will be rounded up to the end of the day."
},
"timezone": {
"type": "string",
"description": "[IANA name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the timezone to format the dates with. If omitted, the export will use Etc/UTC."
},
"filters": {
"$ref": "#/components/schemas/AnalyticsFilters"
}
},
"required": [
"start",
"end",
"type"
]
},
"AnalyticsExportResponse": {
"type": "object",
"required": [
"_links",
"id",
"status",
"progress",
"filters"
],
"properties": {
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to analytics export",
"example": "https://yourCompany.api.frontapp.com/analytics/exports/exp_o9y1a"
}
}
},
"id": {
"type": "string",
"description": "The public ID of the analytics export",
"example": "exp_o9y1a"
},
"status": {
"type": "string",
"enum": [
"running",
"done",
"too_big",
"failed"
],
"description": "Status of the analytics",
"example": "running"
},
"progress": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "Number ranging from 0 to 100 corresponding to the percentage of the analytics processed.",
"example": 20
},
"url": {
"type": "string",
"description": "The URL from which the export data can be downloaded. Only displays after you make a GET request to the link included in the POST response.",
"example": "https://api.frontapp.com/analytics/exports/exp_o9y1a/download"
},
"filename": {
"type": "string",
"description": "The filename of the export with extension included. Only displays after you make a GET request to the link included in the POST response.",
"example": "export-messages-yourCompany-2023-07-19-212d-e55df0.csv"
},
"size": {
"type": "number",
"nullable": true,
"description": "Size (in bytes) of the export data. Only displays after you make a GET request to the link included in the POST response.",
"example": 26639
},
"created_at": {
"type": "number",
"description": "Timestamp (in seconds) at which the export was requested.",
"example": 1703103649.159
},
"filters": {
"$ref": "#/components/schemas/AnalyticsFilters"
}
}
},
"AnalyticsFilters": {
"description": "Resources to compute the analytics for. Defaults to all.",
"anyOf": [
{
"$ref": "#/components/schemas/TagIds"
},
{
"$ref": "#/components/schemas/TeammateIds"
},
{
"$ref": "#/components/schemas/ChannelIds"
},
{
"$ref": "#/components/schemas/InboxIds"
},
{
"$ref": "#/components/schemas/TeamIds"
},
{
"$ref": "#/components/schemas/AccountIds"
}
]
},
"AnalyticsMessagesColumns": {
"type": "string",
"enum": [
"Message ID",
"Segment ID",
"Conversation ID",
"Ticket IDs",
"Segment",
"Direction",
"Status",
"Inbox",
"Inbox API ID",
"Inbox at activity time",
"Inbox API IDs at activity time",
"Message date",
"Autoreply",
"Reaction time",
"Total reply time",
"Handle time",
"Response time",
"Attributed to",
"Assignee",
"Author",
"Contact name",
"Contact handle",
"Account names",
"From",
"To",
"Cc",
"Bcc",
"Extract",
"Tags",
"Tag API IDs",
"Message API ID",
"Conversation API ID",
"New Conversation",
"First response",
"Business hours",
"Subject",
"Segment start",
"Segment end",
"Segment closed",
"Last segment activity",
"Segment cumulative teammates",
"Ticket status name",
"Ticket status category",
"Custom Field"
]
},
"AnalyticsMessagesExportColumns": {
"required": [
"columns"
],
"type": "object",
"properties": {
"columns": {
"type": "array",
"description": "List of the columns to include in the export.\n",
"items": {
"$ref": "#/components/schemas/AnalyticsMessagesColumns"
},
"default": [
"Message ID",
"Segment ID",
"Conversation ID",
"Ticket IDs",
"Segment",
"Direction",
"Status",
"Inbox",
"Inbox API ID",
"Inbox at activity time",
"Inbox API IDs at activity time",
"Message date",
"Autoreply",
"Reaction time",
"Total reply time",
"Handle time",
"Response time",
"Attributed to",
"Assignee",
"Author",
"Contact name",
"Contact handle",
"Account names",
"From",
"To",
"Cc",
"Bcc",
"Extract",
"Tags",
"Tag API IDs",
"Message API ID",
"Conversation API ID",
"New Conversation",
"First response",
"Business hours",
"Subject",
"Segment start",
"Segment end",
"Segment closed",
"Last segment activity",
"Segment cumulative teammates"
]
}
}
},
"AnalyticsMetricId": {
"type": "string",
"enum": [
"avg_csat_survey_response",
"avg_first_response_time",
"avg_handle_time",
"avg_replies_to_resolution",
"avg_resolution_time",
"avg_response_time",
"avg_sla_breach_time",
"avg_total_reply_time",
"new_segments_count",
"num_active_segments_full",
"num_archived_segments",
"num_archived_segments_with_reply",
"num_csat_survey_response",
"num_messages_received",
"num_messages_sent",
"num_sla_breach",
"pct_csat_survey_satisfaction",
"pct_resolved_on_first_reply",
"pct_tagged_conversations",
"num_closed_segments",
"num_open_segments_start",
"num_open_segments_end",
"num_resolved_segments",
"num_unresolved_active_segments",
"num_workload_segments"
]
},
"AnalyticsReportRequest": {
"properties": {
"start": {
"type": "number",
"description": "Start time of the data to include in the export (seconds since 1970-01-01T00:00:00+00). Will be rounded down to the start of the day."
},
"end": {
"type": "number",
"description": "End time of the data to include in the export (seconds since 1970-01-01T00:00:00+00). Will be rounded up to the end of the day."
},
"timezone": {
"type": "string",
"description": "[IANA name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the timezone to format the dates with. If omitted, the export will use Etc/UTC."
},
"filters": {
"$ref": "#/components/schemas/AnalyticsFilters"
},
"metrics": {
"type": "array",
"description": "List of the metrics required.",
"items": {
"$ref": "#/components/schemas/AnalyticsMetricId"
}
}
},
"required": [
"start",
"end",
"metrics"
]
},
"AnalyticsReportResponse": {
"type": "object",
"required": [
"_links",
"uid",
"status",
"progress",
"metrics"
],
"properties": {
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to analytics job.",
"example": "https://yourCompany.api.frontapp.com/analytics/reports/b45efa66237cc453252d9019449c7a64f5cfdb491b6c2c1d6df33c1050d60e33"
}
}
},
"uid": {
"type": "string",
"description": "The UID of the analytics report",
"example": "b45efa66237cc453252d9019449c7a64f5cfdb491b6c2c1d6df33c1050d60e33"
},
"status": {
"type": "string",
"enum": [
"running",
"done",
"failed"
],
"description": "Status of the report.",
"example": "done"
},
"progress": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "Number ranging from 0 to 100 corresponding to the percentage of the analytics processed.",
"example": 100
},
"metrics": {
"type": "array",
"description": "The metrics computed for the report.",
"items": {
"$ref": "#/components/schemas/AnalyticsScalar"
}
}
}
},
"AnalyticsScalar": {
"type": "object",
"required": [
"id",
"type",
"value"
],
"properties": {
"id": {
"$ref": "#/components/schemas/AnalyticsMetricId"
},
"type": {
"$ref": "#/components/schemas/AnalyticsScalarType"
},
"value": {
"$ref": "#/components/schemas/AnalyticsScalarValue"
}
}
},
"AnalyticsScalarType": {
"type": "string",
"example": "number",
"enum": [
"number",
"percentage",
"string",
"duration",
"resource"
]
},
"AnalyticsScalarValue": {
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
},
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"resource": {
"type": "object",
"required": [
"id",
"_links"
],
"properties": {
"id": {
"type": "string"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to a resource."
}
}
}
}
}
}
}
],
"nullable": true,
"description": "The value of a scalar metric."
},
"AppEvent": {
"required": [
"event_type",
"app_object"
],
"properties": {
"event_type": {
"type": "string",
"description": "The type of event this application should handle"
},
"app_object": {
"type": "object",
"description": "Identifier for the app object to which the event is related. Either an ID or an external link is required.\nIf both are provided, the ID will be favored.\n",
"properties": {
"id": {
"type": "string",
"description": "ID of the app object"
},
"ext_link": {
"type": "string",
"description": "External link of the app object"
}
}
}
}
},
"Attachment": {
"type": "object",
"required": [
"id",
"url",
"filename",
"content_type",
"size",
"metadata"
],
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the attachment.",
"example": "fil_3q8a7mby"
},
"filename": {
"type": "string",
"description": "Name of the attached file",
"example": "Andy_Anger_Management_Certificate.png"
},
"url": {
"type": "string",
"description": "URL to download the attached file",
"example": "https://yourCompany.api.frontapp.com/download/fil_3q8a7mby"
},
"content_type": {
"type": "string",
"description": "Content type of the attached file in [MIME format](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types). Note that some attachments types may not be supported.",
"example": "image/png"
},
"size": {
"type": "integer",
"description": "Size (in byte) of the attached file",
"example": 4405
},
"metadata": {
"description": "Attachment metadata",
"type": "object",
"properties": {
"is_inline": {
"type": "boolean",
"description": "Whether or not the attachment is part of the message body",
"example": true
},
"cid": {
"type": "string",
"description": "Unique identifier used to link an attachment to where it is used in the message body",
"example": "526b45586d0e6b1c484afab63d1ef0be"
}
}
}
}
},
"ChannelIds": {
"type": "object",
"required": [
"channel_ids"
],
"properties": {
"channel_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceID"
}
}
}
},
"ChannelResponse": {
"type": "object",
"required": [
"_links",
"id",
"type",
"settings",
"is_private",
"is_valid"
],
"properties": {
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to resource",
"example": "https://yourCompany.api.frontapp.com/channels/cha_1gv4"
},
"related": {
"type": "object",
"properties": {
"inbox": {
"type": "string",
"nullable": true,
"description": "Link to channel inbox",
"example": "https://yourCompany.api.frontapp.com/inboxes/inb_1ix6"
},
"owner": {
"type": "string",
"description": "Link to channel owner",
"example": "https://yourCompany.api.frontapp.com/teams/jen_k30"
}
}
}
}
},
"id": {
"type": "string",
"description": "Unique identifier for the channel",
"example": "cha_1gv4"
},
"name": {
"type": "string",
"description": "The name of the channel",
"example": "Paper Sales Inbox"
},
"address": {
"type": "string",
"description": "Address receiving the messages",
"example": "[email protected]"
},
"type": {
"type": "string",
"description": "Type of the channel",
"enum": [
"custom",
"facebook",
"gmail",
"google_play",
"imap",
"intercom",
"form",
"office365",
"layer_anon",
"smtp",
"talkdesk",
"truly",
"twilio",
"twilio_whatsapp",
"twitter",
"twitter_dm",
"yalo_wha",
"front_chat",
"front_mail"
],
"example": "gmail"
},
"send_as": {
"type": "string",
"description": "Address which appears as the sender for messages sent from Front",
"example": "[email protected]"
},
"settings": {
"type": "object",
"description": "Channel settings",
"properties": {
"undo_send_time": {
"type": "integer",
"description": "The time (measured in seconds) that users have to undo a send operation in the channel.",
"enum": [
0,
5,
10,
15,
30,
60
],
"example": 15
},
"all_teammates_can_reply": {
"type": "boolean",
"description": "Whether teammates without inbox access can reply on this channel. Only present for shared channels; omitted for private channels.",
# --- truncated at 32 KB (484 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/front/refs/heads/main/openapi/front-core-api-openapi.json