POST at this target:
https://joy.classapp.co/graphql?client_id=YOUR_CLIENT_ID
Params | Description |
---|---|
id | The ID of an object |
dbId | Identifies the primary key from the database. |
User's email | |
phone | User's phone |
fullname | User's fullname |
language | Language preference |
tzOffset | The time zone offset from UTC |
documentNumber | Personal document number (CPF) |
onboardingApp | Onboarding on app step |
onboardingSite | Onboarding on site step |
loginMethod | Users can choose the way they will sign in |
confirmEmail | If user confirmed email |
confirmPhone | If user confirmed phone number |
emailNtf | User can be notify by e-mail |
phoneNtf | User can be notify by phone |
webNtf | User can be notify by web |
ntfAnnouncement | Can notify current viewer when there are announcements |
ntfMessage | Can notify when someone sends current viewer a message |
ntfCommitmentRemind | Can notify when current viewer has pending commitments |
ntfReply | Can notify when someone replies to current viewer's message |
ntfSurvey | Can notify when someone responds current viewer's survey |
ntfSurveyPending | Can notify when someone send reminder for current viewer's survey |
ntfCommitment | Can notify when someone confirms current viewer's commitment |
ntfCharge | Can notify when someone pays current viewer's charge |
ntfChargePending | Can notify when someone send reminder for current viewer's charge |
ntfForm | Can notify when someone fills current viewer's form |
ntfFormPending | Can notify when form is pending |
ntfUnread | Can notify when current viewer has unread messages |
ntfArrived | Can notify when arrivals has update |
code | User oauth code to recover password |
verifiedAddressCode | If address code is valid, address is confirmed (just valid for phone yet) |
nextFeedback | date when user will receive pop up to give feedback |
resendFeedback | User should receive pop up to rate after seven days |
needTerms | return true when has terms notifications |
termNotification | Term Notification |
shortname | User shortname |
hasPassword | Has password |
shouldAskForPassword | Should ask to user to create a password |
entities | User has many entities |
addresses | User has many addresses |
acceptedTerms | User has many accepted terms |
invitations | User has many invitations |
applications | Applications managed by the user |
arrivedFilter | Filters notifications and websocket messages from arrivals |
concierges | Concierges filtered by the user |
oauthProvider | Current oauth provider tokens for user |
oauthProviders | User has many oauth |
devices | User has many devices |
tags | Tags from user |
messageDrafts | Message drafts that belongs to entity |
notifications | User has many notifications |
organizations | All organizations user belongs to |
feedbacks | User wrote many feedbacks |
cards | All cards user has |
plans | All plans user has |
vehicles | All vehicles user has |
entitiesWithArrived | Entities with organization arrived enabled |
hasArrivedForStudents | Define if arrived is shown for students of this user |
created | An ISO-8601 encoded UTC date string of when record was created |
modified | An ISO-8601 encoded UTC date string of when record was updated |
deleted | An ISO-8601 encoded UTC date string of when record was deleted |
key | Random ID to differentiate from others |
selected | Helper field for clients |
highlighted | Helper field for clients |
expanded | Helper field for clients |
loaded | Helper field for clients |
loading | Helper field for clients |
Arguments | Type | Description |
---|---|---|
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 |
ntfArrived | LIST UserNotificationType | Can notify when arrivals has update |
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 |
Arguments | Type | Description |
---|---|---|
id | ID SCALAR | The ID of an user object |
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 |
ntfArrived | LIST UserNotificationType | Can notify when arrivals has update |
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 |
Arguments | Type | Description |
---|---|---|
id | ID SCALAR | The ID of an user object |
password | String SCALAR | Current password |
clientMutationId | String SCALAR |