APIDeveloperClassApp WebFale Conosco
Log in

Group
Grupos de uma Organization




POST at this target:

https://joy.classapp.co/graphql?access_token=YOUR_TOKEN_HERE


Group

ParamsDescription
idThe ID of an object
dbIdIdentifies the primary key from the database.
nameGroup's name
internalfor internal staff use
seeAllvisible to all staff
typegroup enum type
organizationIdorganization the class is part of
recipientsCountWhen fetching groups for entity, there is an option to check how many recipients belong to the group
organizationOrganization that group belongs to
entitiesEntities of the group
commitmentsCommitments of the group
createdAn ISO-8601 encoded UTC date string of when record was created
modifiedAn ISO-8601 encoded UTC date string of when record was updated
deletedAn ISO-8601 encoded UTC date string of when record was deleted
keyRandom ID to differentiate from others
selectedHelper field for clients
highlightedHelper field for clients
expandedHelper field for clients
loadedHelper field for clients
loadingHelper field for clients

CreateGroupInput

ArgumentsTypeDescription
organizationId
Not Null
The organization that groups belongs to
name
Not Null
Group's name
internal
Boolean
SCALAR
for internal staff use
seeAll
Boolean
SCALAR
visible to all staff
type
GroupType
ENUM
group enum type
updateIfExists
Boolean
SCALAR
If name exists update Group
clientMutationId
String
SCALAR

UpdateGroupInput

ArgumentsTypeDescription
id
Not Null
The ID of a group object
name
String
SCALAR
Group's name
internal
Boolean
SCALAR
for internal staff use
seeAll
Boolean
SCALAR
visible to all staff
type
GroupType
ENUM
group enum type
clientMutationId
String
SCALAR

DeleteGroupInput

ArgumentsTypeDescription
id
Not Null
The ID of a group object
clientMutationId
String
SCALAR