Teammate groups allow you to create centralized lists of users that make it easier to manage shared inbox and contact access. Learn more about teammate groups in our Help Center.

Teammate groups can be managed by Front or by an external identity provider through SCIM.

The Core API allows you to manage teammate groups in various ways, including creating new teammate groups, adding inboxes to teammate groups, adding or removing teammates from teammate groups, etc.

Example Teammate Group Object

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/teammate_groups"
  },
  "_results": [
    {
      "_links": {
        "self": "https://yourCompany.api.frontapp.com/teammate_groups/cir_123",
        "related": {
          "teammates": "https://yourCompany.api.frontapp.com/teammate_groups/cir_123/teammates",
          "teams": "https://yourCompany.api.frontapp.com/teammate_groups/cir_123/teams",
          "inboxes": "https://yourCompany.api.frontapp.com/teammate_groups/cir_123/inboxes"
        }
      },
      "id": "cir_123",
      "name": "Sales team",
      "description": "Best sales team ever",
      "is_managed_by_scim": false,
      "permissions": {
        "contacts": {
          "access": "contact_lists",
          "contact_group_ids": [
            "grp_1",
            "grp_2"
          ]
        }
      }
    }
  ]
}