Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.14 KB

Group.md

File metadata and controls

27 lines (16 loc) · 1.14 KB

FlatApi.Group

Properties

Name Type Description Notes
id String The unique identifier of the group [optional]
name String The display name of the group [optional]
type String The type of the group: * `generic`: A group created by a Flat user * `classTeachers`: A group created automaticaly by Flat that contains the teachers of a class * `classStudents`: A group created automaticaly by Flat that contains the studnets of a class [optional]
usersCount Number The number of users in this group [optional]
readOnly Boolean `True` if the group is set in read-only [optional]
organization String If the group is related to an organization, this field will contain the unique identifier of the organization [optional]
creationDate Date The creation date of the group [optional]

Enum: TypeEnum

  • generic (value: "generic")

  • classTeachers (value: "classTeachers")

  • classStudents (value: "classStudents")