v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Teammate groups

Get teammate group

Fetch a teammate group.

Required scope: teammate_groups:read

get/teammate_groups/{teammate_group_id}

Path parameters

teammate_group_idstring required

The teammate group ID.

Response

A teammate group

idstring required

Unique identifier of the teammate group

namestring required

The name of the teammate group

descriptionstring nullable required

Description of the teammate group

is_managed_by_scimboolean required

Is teammate group managed by SCIM or by Front

Example response

{
  "_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",
  "permissions": {
    "contacts": {
      "access": "contact_lists",
      "contact_list_ids": [
        "grp_1",
        "grp_2"
      ]
    }
  }
}