Skip to main content

Group

idstring

Group id

Example: Y6K08PEKXG9Q7ZWJ
typestring

Possible values: [none, division, department, team, automated, root]

Example: department
namestring
Example: Information Technology
descriptionstringnullable
slugstring
Example: operations/information-technology
iconstringnullable
Example: code
logostringnullable

Logo URL

parent_idstringnullable

Parent group id

member_countinteger
Example: 12
translationsobjectnullable
created_atstring<date-time>
updated_atstring<date-time>
parent object

Parent group (only present when include=parent)

idstring
Example: Y6K08PEKXG9Q7ZWJ
typestring

Possible values: [none, division, department, team, automated, root]

Example: department
namestring
Example: Information Technology
descriptionstringnullable
slugstring
Example: operations/information-technology
iconstringnullable
Example: code
logostringnullable
parent_idstringnullable
member_countinteger
Example: 12
translationsobjectnullable
created_atstring<date-time>
updated_atstring<date-time>
children object[]

Child groups (only present when include=children)

  • Array [
    • idstring
    Example: Y6K08PEKXG9Q7ZWJ
    typestring

    Possible values: [none, division, department, team, automated, root]

    Example: department
    namestring
    Example: Information Technology
    descriptionstringnullable
    slugstring
    Example: operations/information-technology
    iconstringnullable
    Example: code
    logostringnullable
    parent_idstringnullable
    member_countinteger
    Example: 12
    translationsobjectnullable
    created_atstring<date-time>
    updated_atstring<date-time>
  • ]
    • members object[]

    Group members (only present when include=members)

  • Array [
    • user_idstring
    Example: 1VJEQAYWW54TZ5VD
    namestring
    Example: John Doe
    emailstringnullable

    Email (only visible with view_full_staff_details scope)

    avatarstringnullable

    Avatar URL

    levelstring

    Possible values: [member, team_lead, director, division_director]

    Example: member
    titlestringnullable
    Example: App Developer
    credit_asstringnullable
    Example: J. Doe
  • ]
    • Group
    {
      "id": "Y6K08PEKXG9Q7ZWJ",
      "type": "department",
      "name": "Information Technology",
      "description": "string",
      "slug": "operations/information-technology",
      "icon": "code",
      "logo": "string",
      "parent_id": "string",
      "member_count": 12,
      "translations": {},
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "parent": {
        "id": "Y6K08PEKXG9Q7ZWJ",
        "type": "department",
        "name": "Information Technology",
        "description": "string",
        "slug": "operations/information-technology",
        "icon": "code",
        "logo": "string",
        "parent_id": "string",
        "member_count": 12,
        "translations": {},
        "created_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z"
      },
      "children": [
        {
          "id": "Y6K08PEKXG9Q7ZWJ",
          "type": "department",
          "name": "Information Technology",
          "description": "string",
          "slug": "operations/information-technology",
          "icon": "code",
          "logo": "string",
          "parent_id": "string",
          "member_count": 12,
          "translations": {},
          "created_at": "2024-07-29T15:51:28.071Z",
          "updated_at": "2024-07-29T15:51:28.071Z"
        }
      ],
      "members": [
        {
          "user_id": "1VJEQAYWW54TZ5VD",
          "name": "John Doe",
          "email": "string",
          "avatar": "string",
          "level": "member",
          "title": "App Developer",
          "credit_as": "J. Doe"
        }
      ]
    }