SCALAR
ID
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.
link GraphQL Schema definition
- scalar ID
link Require by
- AcceptedInsurancePlannull
- addDosespotInputAutogenerated input type of addDosespot
- AddedUsersInputnull
- AffiliateInformation on the provider's affiliate abilities
- AllergySensitivityAn allergy/sensitivity/preference for a client
- AnnouncementAnnouncements created by providers for client consumption
- AppleHealthAn Apple Health Sync
- AppointmentAn appointment object containing information about the appointment, including the attendees, date, location, and more
- AppointmentCreditChangeAn object containing appointment type credit change event
- AppointmentInclusionTypeProvider/Client to Appointment connection
- AppointmentLocationA location where appointments are held
- AppointmentLocationInputnull
- AppointmentSettingAppointment Setting options that a provider can customize
- AppointmentTypeAn object containing information about the type of appointment
- AppointmentTypeAppointmentSettingInputnull
- AppointmentTypeCreditAn object containing information the clients' remaining credit for a given appointment type
- AppointmentTypeCreditInputnull
- AppointmentTypeFormConnectionAn object containing event which should be taken before or after appointment
- AppointmentTypeFormConnectionInputnull
- AttendedClientsInputnull
- AvailabilityAn object containing availability ranges for a provider
- BenefitBenefit associated with policy
- BenefitInputnull
- BillingItemBilling
- BrandBrand options that a client can customize
- bulkApplyCarePlanTemplateInputAutogenerated input type of bulkApplyCarePlanTemplate
- bulkApplyInputAutogenerated input type of bulkApply
- bulkUpdateCarePlanUsersInputAutogenerated input type of bulkUpdateCarePlanUsers
- bulkUpdateClientsInputAutogenerated input type of bulkUpdateClients
- bulkUpdateNotificationRecordsInputAutogenerated input type of bulkUpdateNotificationRecords
- CalendarColorSchemeA Calendar Color Scheme
- CalendarColorSchemeInputnull
- CalendarViewSettingView settings for provider calendar
- CallReferenceCall reference information associated with a policy
- CallReferenceInputnull
- CampaignMarketing campaign (email/sms) sent to clients by provider
- CarePlanA Care Plan
- CarePlanConnectionnull
- ChargeBackA Chargeback object, contains info on the dispute reason, status, and evidence submitted
- ChartingItemTypenull
- ChartingNoteAddendumTypenull
- ChatSettingnull
- CheckoutFormAnswerGroupInputnull
- CheckoutFormAnswerInputnull
- ClientInsurancePlanInputnull
- ClientLocationInputnull
- ClientPolicyInputnull
- ClientSourceInputnull
- Cms1500A CMS1500 claim
- Cms1500PolicyA CMS1500 policy
- Cms1500PolicyInputnull
- Cms1500ReferringPhysicianInputnull
- ColorCodeA Calendar Color Scheme
- ColorCodeInputnull
- CommentA comment of an entry
- completeCheckoutInputAutogenerated input type of completeCheckout
- CompletedCourseItema completed course item
- CompletedOnboardingItemAn object with information about how an onboarding item was completed
- ContactTypeA object containing information about whether a specific contact type can be booked
- ContactTypeOverrideInputnull
- ConversationAn association between conversation holders
- ConversationMembership?
- copyCustomModuleFormInputAutogenerated input type of copyCustomModuleForm
- copyCustomModuleInputAutogenerated input type of copyCustomModule
- copyOfferingInputAutogenerated input type of copyOffering
- CourseA Course
- CourseBenefitA Course Benefit
- CourseGroupRelationship between a user group and a course
- CourseItemA Course Item
- CourseMembershipRelationship between a user and a course
- CptCodecpt code
- CptCodesCms1500cpt codes cms 1500s join table
- CptCodesCms1500Inputnull
- CptCodesPolicycpt codes policies join table
- CptCodesPolicyInputnull
- CptCodesSuperBillcpt codes super bills join table
- CptCodesSuperBillInputnull
- createAcceptedInsurancePlanInputAutogenerated input type of createAcceptedInsurancePlan
- createAddendumInputAutogenerated input type of createAddendum
- createAllergySensitivityInputAutogenerated input type of createAllergySensitivity
- createAppointmentSettingInputAutogenerated input type of createAppointmentSetting
- createBillingItemInputAutogenerated input type of createBillingItem
- createCampaignInputAutogenerated input type of createCampaign
- createCarePlanInputAutogenerated input type of createCarePlan
- CreateClientViaFormInputAutogenerated input type of CreateClientViaForm
- createCms1500InputAutogenerated input type of createCms1500
- createCommentInputAutogenerated input type of createComment
- createCompletedOnboardingItemInputAutogenerated input type of createCompletedOnboardingItem
- createConversationInputAutogenerated input type of createConversation
- createDocumentInputAutogenerated input type of createDocument
- createFaxAcctInfoInputAutogenerated input type of createFaxAcctInfo
- createFeatureToggleInputAutogenerated input type of createFeatureToggle
- createFitbitInputAutogenerated input type of createFitbit
- createFormAnswerGroupInputAutogenerated input type of createFormAnswerGroup
- createGoalInputAutogenerated input type of createGoal
- createGoogleFitInputAutogenerated input type of createGoogleFit
- createInsuranceAuthorizationInputAutogenerated input type of createInsuranceAuthorization
- createOfferingInputAutogenerated input type of createOffering
- createOrganizationMembershipInputAutogenerated input type of createOrganizationMembership
- createPaymentIntentInputAutogenerated input type of createPaymentIntent
- createPreferredMedicalCodeInputAutogenerated input type of createPreferredMedicalCode
- createRecommendationInputAutogenerated input type of createRecommendation
- createReferralInputAutogenerated input type of createReferral
- createRequestedFormInputAutogenerated input type of createRequestedForm
- createRequestedPaymentInputAutogenerated input type of createRequestedPayment
- createStripeCustomerDetailInputAutogenerated input type of createStripeCustomerDetail
- createSuperBillInputAutogenerated input type of createSuperBill
- createTagInputAutogenerated input type of createTag
- CustomEmailA custom email
- CustomMetricA custom metric for a user
- CustomMetricInputnull
- CustomMetricOverrideA custom metric for a user
- CustomMetricOverridesInputnull
- CustomModuleA question in a template
- CustomModuleConditionInputnull
- CustomModuleConditionTypeCondition under which to show a custom module
- CustomModuleFormA template for a form, that can then be filled out
- CustomSidebarOverrideA custom sidebar override
- deleteAcceptedInsurancePlanInputAutogenerated input type of deleteAcceptedInsurancePlan
- deleteAllergySensitivityInputAutogenerated input type of deleteAllergySensitivity
- deleteAppleHealthInputAutogenerated input type of deleteAppleHealth
- deleteAppointmentInputAutogenerated input type of deleteAppointment
- deleteAppointmentTypeInputAutogenerated input type of deleteAppointmentType
- deleteAvailabilityInputAutogenerated input type of deleteAvailability
- deleteBillingItemInputAutogenerated input type of deleteBillingItem
- deleteCarePlanConnectionInputAutogenerated input type of deleteCarePlanConnection
- deleteCarePlanInputAutogenerated input type of deleteCarePlan
- deleteCms1500InputAutogenerated input type of deleteCms1500
- deleteCommentInputAutogenerated input type of deleteComment
- deleteConversationMembershipInputAutogenerated input type of deleteConversationMembership
- deleteCourseBenefitInputAutogenerated input type of deleteCourseBenefit
- deleteCourseGroupInputAutogenerated input type of deleteCourseGroup
- deleteCourseInputAutogenerated input type of deleteCourse
- deleteCourseItemInputAutogenerated input type of deleteCourseItem
- deleteCourseMembershipInputAutogenerated input type of deleteCourseMembership
- deleteCustomEmailInputAutogenerated input type of deleteCustomEmail
- deleteCustomFoodInputAutogenerated input type of deleteCustomFood
- deleteCustomModuleFormInputAutogenerated input type of deleteCustomModuleForm
- deleteCustomModuleInputAutogenerated input type of deleteCustomModule
- deleteDexcomConnectionInputAutogenerated input type of deleteDexcomConnection
- deleteDocumentInputAutogenerated input type of deleteDocument
- deleteEntryInputAutogenerated input type of deleteEntry
- deleteExternalCalendarInputAutogenerated input type of deleteExternalCalendar
- deleteFitbitInputAutogenerated input type of deleteFitbit
- deleteFolderInputAutogenerated input type of deleteFolder
- deleteFormAnswerGroupInputAutogenerated input type of deleteFormAnswerGroup
- deleteGoalHistoryInputAutogenerated input type of deleteGoalHistory
- deleteGoalInputAutogenerated input type of deleteGoal
- deleteGoogleFitInputAutogenerated input type of deleteGoogleFit
- deleteInsuranceAuthorizationInputAutogenerated input type of deleteInsuranceAuthorization
- deleteLocationInputAutogenerated input type of deleteLocation
- deleteMealInputAutogenerated input type of deleteMeal
- deleteNoteInputAutogenerated input type of deleteNote
- deleteNotificationContactInputAutogenerated input type of deleteNotificationContact
- deleteOfferingCouponInputAutogenerated input type of deleteOfferingCoupon
- deleteOfferingInputAutogenerated input type of deleteOffering
- deleteOnboardingFlowInputAutogenerated input type of deleteOnboardingFlow
- deleteOnboardingItemInputAutogenerated input type of deleteOnboardingItem
- deleteOrganizationInfoInputAutogenerated input type of deleteOrganizationInfo
- deleteOrganizationMembershipInputAutogenerated input type of deleteOrganizationMembership
- deletePreferredMedicalCodeInputAutogenerated input type of deletePreferredMedicalCode
- deleteProductInputAutogenerated input type of deleteProduct
- deleteReceivedFaxInputAutogenerated input type of deleteReceivedFax
- deleteRecommendationInputAutogenerated input type of deleteRecommendation
- deleteReferralInputAutogenerated input type of deleteReferral
- deleteReferringPhysicianInputAutogenerated input type of deleteReferringPhysician
- deleteRequestedFormInputAutogenerated input type of deleteRequestedForm
- deleteRequestedPaymentInputAutogenerated input type of deleteRequestedPayment
- deleteShapaConnectionInputAutogenerated input type of deleteShapaConnection
- deleteSmartPhraseInputAutogenerated input type of deleteSmartPhrase
- deleteSuperBillInputAutogenerated input type of deleteSuperBill
- deleteTagInputAutogenerated input type of deleteTag
- deleteTaskInputAutogenerated input type of deleteTask
- deleteUserGroupInputAutogenerated input type of deleteUserGroup
- deleteWithingsConnectionInputAutogenerated input type of deleteWithingsConnection
- destroyAnnouncementInputAutogenerated input type of destroyAnnouncement
- destroyFaxAcctInfoInputAutogenerated input type of destroyFaxAcctInfo
- destroyMedicationInputAutogenerated input type of destroyMedication
- destroyRecurringFormInputAutogenerated input type of destroyRecurringForm
- DexcomConnectionA Dexcom Connection
- DiagnosesInputnull
- DiagnosisA diagnosis
- DietitianInputnull
- dismissAllAnnouncementsInputAutogenerated input type of dismissAllAnnouncements
- dismissAnnouncementInputAutogenerated input type of dismissAnnouncement
- DocumentA document file that contains an attachment and information about the attachment
- DocumentViewingInformation about a document being opened
- Draftdraft of a conversation note
- EntryA post about a client, with different category options
- ExternalCalendarAn object containing info about the provider's exrernal calendar
- FaxDietitianInputnull
- FaxLocationInputnull
- FeatureToggleAn object containing details about what the client can and can't do
- FitbitA Fitbit Sync
- FolderA folder that contains documents and other folders
- FoodA food object
- FoodItem
- FoodNutrientA food nutrient item object
- FormAnswerAn answer in a filled form
- FormAnswerGroupA completed form, with metadata about the completion, and the saved answers
- FormAnswerGroupUserConnectionAn instance representing connection between a group charting note(form_answer_group.appointment.is_group == true) and a user
- FormAnswerInputnull
- fullscriptA fullscript Sync
- generateChartingPdfInputAutogenerated input type of generateChartingPdf
- GiftInputnull
- Goala goal
- GoalHistorya goal history
- GoogleFitA GoogleFit Sync
- HealthAssessmentHealth Assessment contains in-depth help info and goals for a client
- HealthAssessmentServiceSignupInputAutogenerated input type of HealthAssessmentServiceSignup
- HumanHuman object controls authentication for users
- IcdCodeicd code
- IcdCodesCms1500icd codes cms 1500s join table
- IcdCodesCms1500Inputnull
- IcdCodesPolicyicd codes policies join table
- IcdCodesPolicyInputnull
- IcdCodesSuperBillicd codes super bills join table
- IcdCodesSuperBillInputnull
- IndividualClientNoteInputnull
- IndividualClientTypeAn object containing an individual note for certain patient associated with group charting note
- InsuranceAuthorizationInputnull
- InsuranceAuthorizationTypenull
- InsurancePlanAn Insurance Plan
- IntakeFlowItemnull
- IntegrationCategoryTypenull
- IntegrationOptionTypenull
- LabOptionLab Option
- LabOrdercpt code
- LocationA location
- LocationInputnull
- LocationInputsnull
- MaskAccountInputAutogenerated input type of MaskAccount
- Meal
- MealPlanA meal plan from
- MedicationOptionTypeMedication query result
- MedicationTypeMedication belonging to client
- mergeClientsInputAutogenerated input type of mergeClients
- NoteChat message object
- NoteSchedulerScheduled chat notes
- NotificationA notification
- NotificationContactA notification contact
- NotificationContactInputnull
- NotificationSettingAn object containing the users preferences on notification
- OfferingOffering (or Package)
- OfferingCouponOffering Coupon
- OfferingCourseOffering Course
- OfferingGroupVisibilityUser groups that are specific to this offering will only be visible to clients in these user groups
- OfferingImageOffering Image
- OfferingIncludeOffering Include
- OfferingIncludesFieldsnull
- OfferingLabOptionOffering Lab Option
- OfferingProductnull
- OfferingProductInputnull
- OfficeallySftpAccountInfo on SFTP connection to OfficeAlly
- OnboardingFlowAn onboarding flow that is comprised of onboarding items
- OnboardingItemAn onboarding item that has something for the client to complete
- OrganizationAn organization, that is an umbrella group for multiple providers
- OrganizationInfoSpecific information for an organization
- OrganizationInfoInputnull
- OrganizationMembershipAn organization membership
- OrgLocationInputnull
- OtherIdNumberAlternative ID numbers for a provider
- OtherIdNumberInputnull
- PatientInputnull
- PatientLocationInputsnull
- PharmacyA pharmacy generated from Dosespot
- PhysicianLocationInputnull
- PhysicianReferralInputnull
- PlaceOfServiceAlternative ID numbers for a provider
- PlanA plan that can be used for a subscription
- PolicyA policy
- PolicyInputnull
- PreferredMedicalCodenull
- PrescriptionPrescription created in Dosespot
- PrimaryOrganizationInfoInputnull
- Productnull
- ProviderApptTypeConnectionnull
- QueryThe query root of this schema. See available queries.
- ReceiptLineItemreceipt line item
- ReceiptLineItemInputnull
- ReceivedFaxA Received Fax
- RecommendationA Care Plan Recommendation
- RecurringAppointmentA Recurring Appointment
- RecurringAppointmentInputnull
- RecurringFormA Recurring Form
- RecurringPaymentRecurring Payment
- Referrala referral
- ReferralInfoThe referral information for a CMS1500 claim
- ReferralInfoInputnull
- ReferralInputnull
- ReferringPhysiciana referring physician
- ReferringPhysicianInputnull
- RefundItemA refinding item of a related billing item
- ReminderA reminder object
- ReminderInputnull
- removeAppliedTagInputAutogenerated input type of removeAppliedTag
- removeDraftInputAutogenerated input type of removeDraft
- ReportsDateFilterSelectionThe selected date range for specific report
- RequestedFormCompletionA request, from a provider to a client, to fill out a form
- RequestedPayerAn Apple Health Sync
- RequestedPayerInputnull
- RequestedPaymentA request, from a provider to a client, to make a payment
- RequestedPaymentTemplateRequested payment template
- RequestedPaymentTemplateInputnull
- RoomA room at a location
- RoomInputnull
- ScheduledUserPackageSelectionBilling items that are scheduled and will have a user package selection associated with them
- sendCarePlanEmailInputAutogenerated input type of sendCarePlanEmail
- SendSpeakToTrainerNotificationInputAutogenerated input type of SendSpeakToTrainerNotification
- SentFaxA Sent Fax
- SentNotificationRecordA Sent Notification
- ServingSizeA serving size object
- ServingSizeInputnull
- ShapaConnectionA Shapa Connection
- shareAnswersAsDocumentInputAutogenerated input type of shareAnswersAsDocument
- shareCourseInputAutogenerated input type of shareCourse
- shareCustomModuleFormInputAutogenerated input type of shareCustomModuleForm
- SmartPhraseA smart phrase object
- SsoConnectionInformation on an SsoConnection
- StateLicenseA state license object
- StateLicensesInputnull
- StripeCustomerDetailDetails on client's credit card
- SubentryInputnull
- SubgoalInputnull
- SubOrganizationInfoInputnull
- Subscriptionnull
- SubscriptionInstancea subscription object
- SuperBillSuperBill
- TagA custom tag that can be applied on a user
- TaskTasks for providers to create, complete, and optionally assign to client profiles
- TaskReminderInputnull
- ToggleAvailabilityInputAutogenerated input type of ToggleAvailability
- toggleCarePlanStatusForSpecificUserInputAutogenerated input type of toggleCarePlanStatusForSpecificUser
- updateAddendumInputAutogenerated input type of updateAddendum
- updateAnnouncementInputAutogenerated input type of updateAnnouncement
- updateAppointmentInputAutogenerated input type of updateAppointment
- updateAppointmentSettingInputAutogenerated input type of updateAppointmentSetting
- updateAppointmentTypeInputAutogenerated input type of updateAppointmentType
- updateBillingItemInputAutogenerated input type of updateBillingItem
- updateBrandInputAutogenerated input type of updateBrand
- updateCalendarViewSettingInputAutogenerated input type of updateCalendarViewSetting
- UpdateCalorieLevelInputAutogenerated input type of UpdateCalorieLevel
- updateCampaignInputAutogenerated input type of updateCampaign
- updateCarePlanInputAutogenerated input type of updateCarePlan
- updateChargeBackInputAutogenerated input type of updateChargeBack
- updateChatSettingInputAutogenerated input type of updateChatSetting
- updateClientInputAutogenerated input type of updateClient
- updateCms1500InputAutogenerated input type of updateCms1500
- updateConversationInputAutogenerated input type of updateConversation
- updateConversationMembershipInputAutogenerated input type of updateConversationMembership
- updateCourseGroupInputAutogenerated input type of updateCourseGroup
- updateCourseMembershipInputAutogenerated input type of updateCourseMembership
- updateCustomEmailInputAutogenerated input type of updateCustomEmail
- updateCustomFoodInputAutogenerated input type of updateCustomFood
- updateCustomModuleFormInputAutogenerated input type of updateCustomModuleForm
- updateCustomModuleInputAutogenerated input type of updateCustomModule
- updateDocumentInputAutogenerated input type of updateDocument
- updateEntryInputAutogenerated input type of updateEntry
- updateExternalCalendarInputAutogenerated input type of updateExternalCalendar
- updateFaxAcctInfoInputAutogenerated input type of updateFaxAcctInfo
- updateFeatureToggleInputAutogenerated input type of updateFeatureToggle
- updateFitbitInputAutogenerated input type of updateFitbit
- updateFolderInputAutogenerated input type of updateFolder
- updateFormAnswerGroupInputAutogenerated input type of updateFormAnswerGroup
- updateGoogleFitInputAutogenerated input type of updateGoogleFit
- updateGroupCarePlanInputAutogenerated input type of updateGroupCarePlan
- updateHumanInputAutogenerated input type of updateHuman
- updateInsuranceAuthorizationInputAutogenerated input type of updateInsuranceAuthorization
- updateLabOrderInputAutogenerated input type of updateLabOrder
- UpdateMacronutrientSplitInputAutogenerated input type of UpdateMacronutrientSplit
- updateMealInputAutogenerated input type of updateMeal
- updateMedicationInputAutogenerated input type of updateMedication
- updateNoteInputAutogenerated input type of updateNote
- updateNoteSchedulerInputAutogenerated input type of updateNoteScheduler
- updateNotificationContactInputAutogenerated input type of updateNotificationContact
- updateNotificationInputAutogenerated input type of updateNotification
- updateNotificationSettingInputAutogenerated input type of updateNotificationSetting
- updateOfferingInputAutogenerated input type of updateOffering
- updateOfficeallySftpAccountInputAutogenerated input type of updateOfficeallySftpAccount
- updateOnboardingFlowInputAutogenerated input type of updateOnboardingFlow
- updateOnboardingItemInputAutogenerated input type of updateOnboardingItem
- updateOrganizationInputAutogenerated input type of updateOrganization
- updateOrganizationMemberInputAutogenerated input type of updateOrganizationMember
- updateOrganizationMembershipInputAutogenerated input type of updateOrganizationMembership
- updatePolicyMutationInputAutogenerated input type of updatePolicyMutation
- updateProductInputAutogenerated input type of updateProduct
- updateReceivedFaxInputAutogenerated input type of updateReceivedFax
- updateRecommendationInputAutogenerated input type of updateRecommendation
- updateReferralInputAutogenerated input type of updateReferral
- updateReferringPhysicianInputAutogenerated input type of updateReferringPhysician
- updateRequestedPaymentInputAutogenerated input type of updateRequestedPayment
- updateSmartPhraseInputAutogenerated input type of updateSmartPhrase
- updateStripeCustomerDetailInputAutogenerated input type of updateStripeCustomerDetail
- updateStripeVerificationDetailsInputAutogenerated input type of updateStripeVerificationDetails
- updateSubscriptionInputAutogenerated input type of updateSubscription
- updateSuperBillInputAutogenerated input type of updateSuperBill
- updateTagInputAutogenerated input type of updateTag
- updateUserGroupInputAutogenerated input type of updateUserGroup
- updateUserInputAutogenerated input type of updateUser
- uploadBatchToOfficeallyInputAutogenerated input type of uploadBatchToOfficeally
- UserAn user entry, returns basic user information
- UserGroupA user group, returns basic info about the user group
- UserNotificationsCountcounts of different types of notifications for a user
- UserPackageSelectionnull
- UserPolicyInputnull
- VideoUrlDefaultnull
- VideoUrlOptionnull
- VisitorInfo about a visitor to the site
- WhitelabelSettingInfo for Whitelabeling
- WithingsConnectionA Withings Connection
- ZoomAppointmentZoom meeting retrieved from Zoom API