v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Teammate groups

List teammate group team inboxes

List inboxes that the teammate group has access to via its associated teams.

Required scope: inboxes:read

get/teammate_groups/{teammate_group_id}/inboxes

Path parameters

teammate_group_idstring required

The teammate group ID.

Response

Array of Inboxes

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/inboxes"
  },
  "_results": [
    {
      "_links": {
        "self": "https://yourCompany.api.frontapp.com/inboxes/inb_1ix6",
        "related": {
          "teammates": "https://yourCompany.api.frontapp.com/inboxes/inb_1ix6/teammates",
          "conversations": "https://yourCompany.api.frontapp.com/inboxes/inb_1ix6/conversations",
          "channels": "https://yourCompany.api.frontapp.com/inboxes/inb_1ix6/channels",
          "owner": "https://yourCompany.api.frontapp.com/teams/tim_k30"
        }
      },
      "id": "inb_1ix6",
      "name": "The Dundies",
      "is_public": 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"
      }
    }
  ]
}