User
Detalhes dos usuários




POST at this target:

https://joy.classapp.co/graphql?client_id=YOUR_CLIENT_ID


User

ParamsDescription
idThe ID of an object
dbIdIdentifies the primary key from the database.
emailUser's email
phoneUser's phone
fullnameUser's fullname
languageLanguage preference
tzOffsetThe time zone offset from UTC
documentNumberPersonal document number (CPF)
onboardingAppOnboarding on app step
onboardingSiteOnboarding on site step
loginMethodUsers can choose the way they will sign in
confirmEmailIf user confirmed email
confirmPhoneIf user confirmed phone number
emailNtfUser can be notify by e-mail
phoneNtfUser can be notify by phone
webNtfUser can be notify by web
ntfAnnouncementCan notify current viewer when there are announcements
ntfMessageCan notify when someone sends current viewer a message
ntfCommitmentRemindCan notify when current viewer has pending commitments
ntfReplyCan notify when someone replies to current viewer's message
ntfSurveyCan notify when someone responds current viewer's survey
ntfSurveyPendingCan notify when someone send reminder for current viewer's survey
ntfCommitmentCan notify when someone confirms current viewer's commitment
ntfChargeCan notify when someone pays current viewer's charge
ntfChargePendingCan notify when someone send reminder for current viewer's charge
ntfFormCan notify when someone fills current viewer's form
ntfFormPendingCan notify when form is pending
ntfUnreadCan notify when current viewer has unread messages
codeUser oauth code to recover password
verifiedAddressCodeIf address code is valid, address is confirmed (just valid for phone yet)
nextFeedbackdate when user will receive pop up to give feedback
resendFeedbackUser should receive pop up to rate after seven days
needTermsreturn true when has terms notifications
termNotificationTerm Notification
shortnameUser shortname
hasPasswordHas password
shouldAskForPasswordShould ask to user to create a password
entitiesUser has many entities
addressesUser has many addresses
acceptedTermsUser has many accepted terms
invitationsUser has many invitations
applicationsApplications managed by the user
oauthProviderCurrent oauth provider tokens for user
oauthProvidersUser has many oauth
devicesUser has many devices
tagsTags from user
messageDraftsMessage drafts that belongs to entity
notificationsUser has many notifications
organizationsAll organizations user belongs to
feedbacksUser wrote many feedbacks
cardsAll cards user has
plansAll plans user has
vehiclesAll vehicles user has
entitiesWithArrivedEntities with organization arrived enabled
hasArrivedForStudentsDefine if arrived is shown for students of this user
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

CreateUserInput

ArgumentsTypeDescription
email
String
SCALAR
User's email
phone
String
SCALAR
User's phone
fullname
Not Null
User's fullname
language
String
SCALAR
Language preference
tzOffset
Int
SCALAR
The time zone offset from UTC
documentNumber
String
SCALAR
Personal document number (CPF)
onboardingApp
String
SCALAR
Onboarding on app step
onboardingSite
String
SCALAR
Onboarding on site step
loginMethod
LoginMethodEnum
ENUM
Users can choose the way they will sign in
confirmEmail
Boolean
SCALAR
User can be notify by e-mail
confirmPhone
Boolean
SCALAR
User can be notify by phone
emailNtf
Boolean
SCALAR
User can be notify by e-mail
phoneNtf
Boolean
SCALAR
User can be notify by phone
webNtf
Boolean
SCALAR
User can be notify by web
ntfAnnouncement
Boolean
SCALAR
Can notify current viewer when there are announcements
ntfMessage
LIST
UserNotificationType
Can notify when someone sends current viewer a message
ntfCommitmentRemind
LIST
UserNotificationType
Can notify when current viewer has pending commitments
ntfReply
LIST
UserNotificationType
Can notify when someone replies to current viewer's message
ntfSurvey
LIST
UserNotificationType
Can notify when someone responds current viewer's survey
ntfSurveyPending
LIST
UserNotificationType
Can notify when someone send reminder for current viewer's survey
ntfCommitment
LIST
UserNotificationType
Can notify when someone confirms current viewer's commitment
ntfCharge
LIST
UserNotificationType
Can notify when someone pays current viewer's charge
ntfChargePending
LIST
UserNotificationType
Can notify when someone send reminder for current viewer's charge
ntfForm
LIST
UserNotificationType
Can notify when someone fills current viewer's form
ntfFormPending
LIST
UserNotificationType
Can notify when form is pending
ntfUnread
LIST
UserNotificationType
Can notify when current viewer has unread messages
code
String
SCALAR
User oauth code to recover password
verifiedAddressCode
String
SCALAR
If address code is valid, address is confirmed (just valid for phone yet)
nextFeedback
String
SCALAR
Date when user will receive pop up to give feedback
resendFeedback
Boolean
SCALAR
User should receive pop up to rate after seven days
password
String
SCALAR
New password, optional
isNewCode
Boolean
SCALAR
should send six digit confirm address code
addresses
LIST
UserAddressesInput
clientMutationId
String
SCALAR

UpdateUserInput

ArgumentsTypeDescription
id
ID
SCALAR
The ID of an user object
email
String
SCALAR
User's email
phone
String
SCALAR
User's phone
fullname
String
SCALAR
User's fullname
language
String
SCALAR
Language preference
tzOffset
Int
SCALAR
The time zone offset from UTC
documentNumber
String
SCALAR
Personal document number (CPF)
onboardingApp
String
SCALAR
Onboarding on app step
onboardingSite
String
SCALAR
Onboarding on site step
loginMethod
LoginMethodEnum
ENUM
Users can choose the way they will sign in
confirmEmail
Boolean
SCALAR
User can be notify by e-mail
confirmPhone
Boolean
SCALAR
User can be notify by phone
emailNtf
Boolean
SCALAR
User can be notify by e-mail
phoneNtf
Boolean
SCALAR
User can be notify by phone
webNtf
Boolean
SCALAR
User can be notify by web
ntfAnnouncement
Boolean
SCALAR
Can notify current viewer when there are announcements
ntfMessage
LIST
UserNotificationType
Can notify when someone sends current viewer a message
ntfCommitmentRemind
LIST
UserNotificationType
Can notify when current viewer has pending commitments
ntfReply
LIST
UserNotificationType
Can notify when someone replies to current viewer's message
ntfSurvey
LIST
UserNotificationType
Can notify when someone responds current viewer's survey
ntfSurveyPending
LIST
UserNotificationType
Can notify when someone send reminder for current viewer's survey
ntfCommitment
LIST
UserNotificationType
Can notify when someone confirms current viewer's commitment
ntfCharge
LIST
UserNotificationType
Can notify when someone pays current viewer's charge
ntfChargePending
LIST
UserNotificationType
Can notify when someone send reminder for current viewer's charge
ntfForm
LIST
UserNotificationType
Can notify when someone fills current viewer's form
ntfFormPending
LIST
UserNotificationType
Can notify when form is pending
ntfUnread
LIST
UserNotificationType
Can notify when current viewer has unread messages
code
String
SCALAR
User oauth code to recover password
verifiedAddressCode
String
SCALAR
If address code is valid, address is confirmed (just valid for phone yet)
nextFeedback
String
SCALAR
Date when user will receive pop up to give feedback
resendFeedback
Boolean
SCALAR
User should receive pop up to rate after seven days
password
String
SCALAR
Current password
newPassword
String
SCALAR
New password
isNewCode
Boolean
SCALAR
should send six digit confirm address code
scope
UserScope
ENUM
clientMutationId
String
SCALAR

DeleteUserInput

ArgumentsTypeDescription
id
ID
SCALAR
The ID of an user object
password
String
SCALAR
Current password
clientMutationId
String
SCALAR