v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Conversations

List conversation events

List the events that occured for a conversation in reverse chronological order (newest first). The order will respect your company's bump settings, which determine when conversations bump to the top.

Required scope: events:*:read

get/conversations/{conversation_id}/events

Path parameters

conversation_idstring required

The conversation ID

Query parameters

limitinteger
Example:25

Max number of results per page

page_tokenstring
Example:https://yourCompany.api.frontapp.com/endpoint?limit=25&page_token=92f32bcd7625333caf4e0f8fc26d920c812f

Token to use to request the next page

Response

Array of events

Example response

{
  "_pagination": {
    "next": "https://yourCompany.api.frontapp.com/events?page_token=2d018a5809eb90d349bc08c52cb1f4987bef"
  },
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/events"
  },
  "_results": [
    {
      "_links": {
        "self": "https://yourCompany.api.frontapp.com/events/evt_4ckcra8e"
      },
      "id": "evt_4ckcra8e",
      "type": "inbound",
      "emitted_at": 1703102616,
      "source": {
        "_meta": {
          "type": "inboxes"
        },
        "data": {
          "_links": {
            "self": "https://yourCompany.api.frontapp.com/rules/rul_58xhq"
          },
          "id": "rul_58xhq",
          "name": "Scranton new account workflow"
        }
      },
      "target": {
        "_meta": {
          "type": "inboxes"
        },
        "data": {
          "_links": {
            "self": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a",
            "related": {
              "inboxes": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a/inboxes",
              "conversations": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a/conversations",
              "botSource": "https://yourCompany.api.frontapp.com/rules/rul_6r55a"
            }
          },
          "id": "tea_6r55a",
          "email": "michael.scott@dundermifflin.com",
          "username": "PrisonMike",
          "first_name": "Michael",
          "last_name": "Scott",
          "is_admin": true,
          "custom_fields": {
            "city": "London, UK",
            "isVIP": true,
            "renewal_date": 1525417200,
            "sla_time": 90,
            "owner": "leela@planet-express.com",
            "replyTo": "inb_55c8c149",
            "Job Title": "firefighter"
          }
        }
      },
      "conversation": {
        "_links": {
          "self": "https://yourCompany.api.frontapp.com/conversations/cnv_yo1kg5q",
          "related": {
            "events": "https://yourCompany.api.frontapp.com/conversations/cnv_yo1kg5q/events",
            "followers": "https://yourCompany.api.frontapp.com/conversations/cnv_yo1kg5q/followers",
            "messages": "https://yourCompany.api.frontapp.com/conversations/cnv_yo1kg5q/messages",
            "comments": "https://yourCompany.api.frontapp.com/conversations/cnv_yo1kg5q/comments",
            "inboxes": "https://yourCompany.api.frontapp.com/conversations/cnv_yo1kg5q/inboxes",
            "last_message": "https://yourCompany.api.frontapp.com/messages/msg_1q15qmtq?referer=conversation"
          }
        },
        "id": "cnv_yo1kg5q",
        "type": "discussion",
        "subject": "How to prank Dwight Schrute",
        "status": "assigned",
        "status_id": "sts_5x",
        "status_category": "resolved",
        "ticket_ids": [
          "TICKET-1"
        ],
        "assignee": {
          "_links": {
            "self": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a",
            "related": {
              "inboxes": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a/inboxes",
              "conversations": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a/conversations",
              "botSource": "https://yourCompany.api.frontapp.com/rules/rul_6r55a"
            }
          },
          "id": "tea_6r55a",
          "email": "michael.scott@dundermifflin.com",
          "username": "PrisonMike",
          "first_name": "Michael",
          "last_name": "Scott",
          "is_admin": true,
          "custom_fields": {
            "city": "London, UK",
            "isVIP": true,
            "renewal_date": 1525417200,
            "sla_time": 90,
            "owner": "leela@planet-express.com",
            "replyTo": "inb_55c8c149",
            "Job Title": "firefighter"
          }
        },
        "recipient": {
          "_links": {
            "related": {
              "contact": "https://yourCompany.api.frontapp.com/contacts/crd_2njtoem"
            }
          },
          "name": "Phyllis Lapin-Vance",
          "handle": "purpleboss@limitlesspaper.com",
          "role": "cc"
        },
        "tags": [
          {
            "_links": {
              "self": "https://yourCompany.api.frontapp.com/tags/tag_2oxhvy",
              "related": {
                "conversations": "https://yourCompany.api.frontapp.com/tags/tag_2oxhvy/conversations",
                "owner": "https://yourCompany.api.frontapp.com/teammates/tea_6jydq",
                "parent_tag": "https://yourCompany.api.frontapp.com/tags/tag_3h07ym",
                "children": "https://yourCompany.api.frontapp.com/tags/tag_2oxhvy/children"
              }
            },
            "id": "tag_2oxhvy",
            "name": "Warehouse task",
            "description": "Sitting on your biscuit, never having to risk it",
            "is_visible_in_conversation_lists": true,
            "created_at": 1682538996.583,
            "updated_at": 1699575875.186
          }
        ],
        "links": [
          {
            "_links": {
              "self": "https://yourCompany.api.frontapp.com/links/top_b2wpa"
            },
            "id": "top_b2wpa",
            "name": "JIRA-SCRAN-4567",
            "type": "app_2f76b9ac738de158",
            "external_url": "https://dundermifflin.atlassian.net/browse/PB-SCRAN-4567",
            "custom_fields": {
              "city": "London, UK",
              "isVIP": true,
              "renewal_date": 1525417200,
              "sla_time": 90,
              "owner": "leela@planet-express.com",
              "replyTo": "inb_55c8c149",
              "Job Title": "firefighter"
            }
          }
        ],
        "custom_fields": {
          "city": "London, UK",
          "isVIP": true,
          "renewal_date": 1525417200,
          "sla_time": 90,
          "owner": "leela@planet-express.com",
          "replyTo": "inb_55c8c149",
          "Job Title": "firefighter"
        },
        "created_at": 1701292649.333,
        "updated_at": 1701292649.333,
        "waiting_since": 1701292649.333,
        "is_private": true,
        "scheduled_reminders": [
          {
            "_links": {
              "related": {
                "owner": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a"
              }
            },
            "created_at": 1701806790.536,
            "scheduled_at": 1701874800,
            "updated_at": 1701806790.536
          }
        ],
        "due_at": 1701292649.333,
        "metadata": {
          "external_conversation_ids": [
            "JS3949",
            "JS9403"
          ]
        }
      }
    }
  ]
}