DeveloperPOST at this target:
https://joy.classapp.co/graphql?access_token=YOUR_TOKEN_HERE
OrganizationA instituição
Organization
| Params | Description |
|---|---|
| id | The ID of an object |
| dbId | Identifies the primary key from the database. |
| type | Type of organization |
| plan | Plan of organization |
| username | unique username |
| fullname | display name |
| color | theme color |
| link | url for more info |
| tzOffset | timezone offset from UTC |
| confMessage | Message can be sent |
| confMessageStudent | Parent/student can send messages |
| confMessageStaff | Staff can send messages |
| confMedia | Media can be sent |
| confAudio | Audio can be sent |
| confAudioStudent | Audio can be sent by students |
| confOtherFiles | Other files can be sent |
| confCommitment | Commitment can be sent |
| confSurvey | Survey can be sent |
| confReport | Report can be sent |
| confCharge | Charge can be sent |
| confChargeList | Charge list can be showed for entities |
| confForm | Form can be sent |
| confReplyStudent | Parent/student can send replies |
| confMediaStudent | Parent/student can send media |
| confTerms | Terms that were accepted by the user |
| confPresence | Presence can be sent |
| confAdminList | Show admin list for staff |
| confRecurrence | Organization has access to recurrrence module |
| confAnticipationDiscount | Allow anticipation discount for charges |
| confFine | Allow fine for charges |
| confInterest | Allow interest for charges |
| confPaymentDetailsInboleto | Allow boleto details for fine payments |
| confChannelMetrics | Parent/student can see channels metrics before sending messages |
| confArrived | If arrived feature are enabled this sends true |
| confRepliesStudent | Combined with confReplyStudent this tells if students can reply more than once time. |
| anticipationDiscountUntil | Number of days before the expiration of a charge that the discount is still applied |
| anticipationDiscountType | Type of the discount (percentange or amount) |
| anticipationDiscountValue | Discount value in percentage or total amount |
| fineStart | Number of days after the expiration of a charge that the fine should start |
| fineType | Type of the fine (percentange or amount) |
| fineValue | Fine value in percentage or total amount |
| interestStart | Number of days after the expiration of a charge that the interest should start |
| interestType | Type of the interest (percentange or amount) |
| interestValue | interest value in percentage or total amount |
| consultantId | consultant entity id |
| client | type of client |
| usage | Why this organization exists in ClassApp. |
| entryMethod | entry method for organization |
| latitude | latitude of organization |
| longitude | longitude of organization |
| timezone | base timezone of organization |
| language | preferred language |
| country | preferred country |
| currency | preferred currency |
| ntfStartTime | time that users of this organization start to receive notifications |
| ntfEndTime | time that users of this organization start to receive notifications |
| ntfWeekDays | week days that users of this organization receive notifications |
| legalName | Organization legal name |
| taxId | Country tax id (Brazil -> CNPJ or CPF) (US -> EIN) |
| phone | Contact phone number |
| Contact email address | |
| addressStreet | Street address of the account holder |
| addressNumber | Address number of the account holder |
| addressComplement | Address complement of the account holder |
| zipCode | Zip code of the account holder |
| neighborhood | Neighborhood of the account holder |
| addressState | abbreviated state of the account holder (ex: SP) |
| city | City of the account holder |
| ntfWeekDaysArray | days of the week to receive notification |
| user | User who created organization |
| live | live in production = 1 |
| support | has support |
| features | Organization features based on plan |
| premiumPeriod | Until when the organization has the right to use premium features |
| acceptedTerms | Terms who was created for organization |
| membership | Entities with users at the organization (members) |
| readingRate | Rate of messages read in organization |
| replyTimeStats | Average reply time of staffs and admins in organization |
| replyStats | |
| monthlyMessagesCount | Number of messages sent by admins and staff to students this month in this organization |
| monthlyMessageQuota | Number of messages that admins and staff can send per student monthly |
| dailyEntityMessagesMetrics | Metrics from channels from the organization |
| dailyMessagesMetrics | Summary metrics from channels from the organization |
| messageStats | |
| entityMessageStats | |
| paymentStats | Number of payments made to organization |
| permissions | |
| logo | Logo of organization page |
| cover | Cover of organization page |
| consultant | consultant entity |
| arrivals | Organization arrivals |
| hasArrivedForStaff | Should show arrived for staff |
| myEntities | My entities (user) inside organization |
| organizationInvoicesInformations | Contains informations about organization invoices |
| financialInformations | This contains some informations about payments on organization |
| entities | Entities of organization |
| recipientTags | Recipient tags from organization |
| groups | Groups of organization |
| tags | Tags from organization |
| links | Links of organization |
| applicationAccess | Application access of organization |
| labels | Labels of an organization |
| reports | Organization's report |
| forms | Organization's forms |
| accounts | All accounts in organization |
| collectionRule | organization's collection rules |
| plans | Organization's plans |
| products | Organization's products |
| messages | Organization's messages |
| moments | Organization's moments |
| messageDrafts | Message drafts that belongs to organization entities |
| commitments | Organization's commitments |
| chargeRecipients | Charge recipients made to organization |
| organizationBanners | Banners in this organization |
| payments | Charge payments made to organization |
| charges | Charges sent by organization |
| invoices | Invoices of the organization |
| webhooks | Organization's webhooks |
| application | Application |
| onboarding | OrganizationOnboarding |
| isOnboarding | Is the Organization Onboarding? |
| integration | Integrations used by organization |
| withdrawals | Organization's withdrawals |
| isDemonstration | Is the Organization on a Demonstration? |
| overdueInvoicesStats | Overdue invoices stats in the organization |
| integrationContract | Contracts of integrations used by organization |
| concierges | Concierges related to this organization |
| arrivedConfiguration | |
| entitiesWithArrived | Info about Arrived adhesion |
| productFeatures | ProductFeatures enabled for an organization |
| hasProductFeature | Flag if an organization has a ProductFeature enabled |
| getLaunchedProductFeature | |
| 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 |
CreateOrganizationInput
| Arguments | Type | Description |
|---|---|---|
| type | OrganizationType ENUM | Type of organization |
| plan | OrganizationPlan ENUM | Plan of organization |
| username | String SCALAR | unique username |
| fullname | Not Null | display name |
| color | String SCALAR | theme color |
| link | String SCALAR | url for more info |
| tzOffset | Int SCALAR | timezone offset from UTC |
| confMessage | Boolean SCALAR | Message can be sent |
| confMessageStudent | Boolean SCALAR | Parent/student can send messages |
| confMessageStaff | Boolean SCALAR | Staff can send messages |
| confMedia | Boolean SCALAR | Media can be sent |
| confAudio | Boolean SCALAR | Audio can be sent |
| confAudioStudent | Boolean SCALAR | Audio can be sent by students |
| confOtherFiles | Boolean SCALAR | Other files can be sent |
| confCommitment | Boolean SCALAR | Commitment can be sent |
| confSurvey | Boolean SCALAR | Survey can be sent |
| confReport | Boolean SCALAR | Report can be sent |
| confCharge | Boolean SCALAR | Charge can be sent |
| confChargeList | Boolean SCALAR | Charge list can be showed for entities |
| confForm | Boolean SCALAR | Form can be sent |
| confReplyStudent | Boolean SCALAR | Parent/student can send replies |
| confMediaStudent | Boolean SCALAR | Parent/student can send media |
| confTerms | LIST String | Terms that were accepted by the user |
| confPresence | Boolean SCALAR | Presence can be sent |
| confAdminList | Boolean SCALAR | Show admin list for staff |
| confRecurrence | Boolean SCALAR | Organization has access to recurrrence module |
| confAnticipationDiscount | Boolean SCALAR | Allow anticipation discount for charges |
| confFine | Boolean SCALAR | Allow fine for charges |
| confInterest | Boolean SCALAR | Allow interest for charges |
| confPaymentDetailsInboleto | Boolean SCALAR | Allow boleto details for fine payments |
| confChannelMetrics | Boolean SCALAR | Parent/student can see channels metrics before sending messages |
| confArrived | Boolean SCALAR | If arrived feature are enabled this sends true |
| confRepliesStudent | Boolean SCALAR | Combined with confReplyStudent this tells if students can reply more than once time. |
| anticipationDiscountUntil | Int SCALAR | Number of days before the expiration of a charge that the discount is still applied |
| anticipationDiscountType | DiscountType ENUM | Type of the discount (percentange or amount) |
| anticipationDiscountValue | Float SCALAR | Discount value in percentage or total amount |
| fineStart | Int SCALAR | Number of days after the expiration of a charge that the fine should start |
| fineType | DiscountType ENUM | Type of the fine (percentange or amount) |
| fineValue | Float SCALAR | Fine value in percentage or total amount |
| interestStart | Int SCALAR | Number of days after the expiration of a charge that the interest should start |
| interestType | DiscountType ENUM | Type of the interest (percentange or amount) |
| interestValue | Float SCALAR | interest value in percentage or total amount |
| consultantId | Int SCALAR | consultant id of organization |
| client | Boolean SCALAR | is paying client |
| usage | OrganizationUsage ENUM | Why this organization exists in ClassApp. |
| entryMethod | OrganizationEntryMethod ENUM | entry method for organization |
| latitude | String SCALAR | latitude of organization |
| longitude | String SCALAR | longitude of organization |
| timezone | String SCALAR | base timezone of organization |
| language | String SCALAR | preferred language |
| country | String SCALAR | preferred country |
| currency | Currency ENUM | preferred currency |
| ntfStartTime | String SCALAR | time that users of this organization start to receive notifications |
| ntfEndTime | String SCALAR | time that users of this organization start to receive notifications |
| ntfWeekDays | Int SCALAR | week days that users of this organization receive notifications |
| legalName | String SCALAR | Organization legal name |
| taxId | String SCALAR | Country tax id (Brazil -> CNPJ or CPF) (US -> EIN) |
| phone | String SCALAR | Contact phone number |
String SCALAR | Contact email address | |
| addressStreet | String SCALAR | Street address of the account holder |
| addressNumber | String SCALAR | Address number of the account holder |
| addressComplement | String SCALAR | Address complement of the account holder |
| zipCode | String SCALAR | Zip code of the account holder |
| neighborhood | String SCALAR | Neighborhood of the account holder |
| addressState | String SCALAR | abbreviated state of the account holder (ex: SP) |
| city | String SCALAR | City of the account holder |
| ntfWeekDaysArray | LIST String | days of the week to receive notification |
| includeViewer | Boolean SCALAR | Add currently authenticated user |
| recipientTags | LIST OrganizationTagsInput | |
| user | OrganizationUserInput INPUT_OBJECT | |
| entity | OrganizationEntityInput INPUT_OBJECT | |
| defaultFeatures | LIST DefaultFeatures | Features that should have default items |
| invite | InviteEnum ENUM | Send invitations |
| clientMutationId | String SCALAR |
UpdateOrganizationInput
| Arguments | Type | Description |
|---|---|---|
| id | Not Null | The ID of an organization object |
| includeViewer | Boolean SCALAR | Add currently authenticated user |
| recipientTags | LIST OrganizationTagsInput | |
| user | OrganizationUserInput INPUT_OBJECT | |
| entity | OrganizationEntityInput INPUT_OBJECT | |
| type | OrganizationType ENUM | Type of organization |
| plan | OrganizationPlan ENUM | Plan of organization |
| username | String SCALAR | unique username |
| fullname | String SCALAR | display name |
| color | String SCALAR | theme color |
| link | String SCALAR | url for more info |
| tzOffset | Int SCALAR | timezone offset from UTC |
| confMessage | Boolean SCALAR | Message can be sent |
| confMessageStudent | Boolean SCALAR | Parent/student can send messages |
| confMessageStaff | Boolean SCALAR | Staff can send messages |
| confMedia | Boolean SCALAR | Media can be sent |
| confAudio | Boolean SCALAR | Audio can be sent |
| confAudioStudent | Boolean SCALAR | Audio can be sent by students |
| confOtherFiles | Boolean SCALAR | Other files can be sent |
| confCommitment | Boolean SCALAR | Commitment can be sent |
| confSurvey | Boolean SCALAR | Survey can be sent |
| confReport | Boolean SCALAR | Report can be sent |
| confCharge | Boolean SCALAR | Charge can be sent |
| confChargeList | Boolean SCALAR | Charge list can be showed for entities |
| confForm | Boolean SCALAR | Form can be sent |
| confReplyStudent | Boolean SCALAR | Parent/student can send replies |
| confMediaStudent | Boolean SCALAR | Parent/student can send media |
| confTerms | LIST String | Terms that were accepted by the user |
| confPresence | Boolean SCALAR | Presence can be sent |
| confAdminList | Boolean SCALAR | Show admin list for staff |
| confRecurrence | Boolean SCALAR | Organization has access to recurrrence module |
| confAnticipationDiscount | Boolean SCALAR | Allow anticipation discount for charges |
| confFine | Boolean SCALAR | Allow fine for charges |
| confInterest | Boolean SCALAR | Allow interest for charges |
| confPaymentDetailsInboleto | Boolean SCALAR | Allow boleto details for fine payments |
| confChannelMetrics | Boolean SCALAR | Parent/student can see channels metrics before sending messages |
| confArrived | Boolean SCALAR | If arrived feature are enabled this sends true |
| confRepliesStudent | Boolean SCALAR | Combined with confReplyStudent this tells if students can reply more than once time. |
| anticipationDiscountUntil | Int SCALAR | Number of days before the expiration of a charge that the discount is still applied |
| anticipationDiscountType | DiscountType ENUM | Type of the discount (percentange or amount) |
| anticipationDiscountValue | Float SCALAR | Discount value in percentage or total amount |
| fineStart | Int SCALAR | Number of days after the expiration of a charge that the fine should start |
| fineType | DiscountType ENUM | Type of the fine (percentange or amount) |
| fineValue | Float SCALAR | Fine value in percentage or total amount |
| interestStart | Int SCALAR | Number of days after the expiration of a charge that the interest should start |
| interestType | DiscountType ENUM | Type of the interest (percentange or amount) |
| interestValue | Float SCALAR | interest value in percentage or total amount |
| consultantId | Int SCALAR | consultant id of organization |
| client | Boolean SCALAR | is paying client |
| usage | OrganizationUsage ENUM | Why this organization exists in ClassApp. |
| entryMethod | OrganizationEntryMethod ENUM | entry method for organization |
| latitude | String SCALAR | latitude of organization |
| longitude | String SCALAR | longitude of organization |
| timezone | String SCALAR | base timezone of organization |
| language | String SCALAR | preferred language |
| country | String SCALAR | preferred country |
| currency | Currency ENUM | preferred currency |
| ntfStartTime | String SCALAR | time that users of this organization start to receive notifications |
| ntfEndTime | String SCALAR | time that users of this organization start to receive notifications |
| ntfWeekDays | Int SCALAR | week days that users of this organization receive notifications |
| legalName | String SCALAR | Organization legal name |
| taxId | String SCALAR | Country tax id (Brazil -> CNPJ or CPF) (US -> EIN) |
| phone | String SCALAR | Contact phone number |
String SCALAR | Contact email address | |
| addressStreet | String SCALAR | Street address of the account holder |
| addressNumber | String SCALAR | Address number of the account holder |
| addressComplement | String SCALAR | Address complement of the account holder |
| zipCode | String SCALAR | Zip code of the account holder |
| neighborhood | String SCALAR | Neighborhood of the account holder |
| addressState | String SCALAR | abbreviated state of the account holder (ex: SP) |
| city | String SCALAR | City of the account holder |
| ntfWeekDaysArray | LIST String | days of the week to receive notification |
| invite | InviteEnum ENUM | Send invitations |
| clientMutationId | String SCALAR |
DeleteOrganizationInput
| Arguments | Type | Description |
|---|---|---|
| id | Not Null | The ID of an organization object |
| clientMutationId | String SCALAR |