Search documentation…
/
Support
API Reference
CheckEmailDTO
Documentation
API Reference
MCP Reference
API Reference
Documentation
API Reference
MCP Reference
Introduction
Authentication
AI Chat
Role
AI Chat Plugin
Documents Plugin
Feature
TenantSetting
Changelog
ActivePieces Integration
ActivePieces MCP Server Integration
IntegrationsEntitySetting
IntegrationTenant
IntegrationSetting
IntegrationEntitySettingTied
Tasks
User
Employee
CustomSmtp
EmailTemplate
Organization
UserOrganization
Tenant
Auth
EmailVerification
Auth0
Facebook
Github
Google
Linkedin
Twitter
Microsoft
OAuthAppController_
1
OrganizationTeam
OAuthClient
Terms
Email
Contact
OrganizationTeamEmployee
Timer Tracker
TimeLog
OrganizationProject
EmployeeRecentVisit
OrganizationContact
TimeSlot
Activity
TimesheetStatistic
OrganizationSprint
Task views
EmployeeNotification
EmployeeNotificationSetting
Tags
Integrations
GitHubAuthorizationController_
1
GitHub Integrations
GitHubIntegration
GitHubSync
GitHubRepository
Hubstaff Integrations
Screenshot
Make.com Integrations
Make.com OAuth
Make.com API
Hook
Upwork Integrations
ExpenseCategories
Expense
EmployeeStatistics
OrganizationRecurringExpense
EmployeeRecurringExpense
Income
OrganizationVendor
Proposal
Plane Integration
TenantAPIKeys
Ever Async Integration
Ever Async Connector
SIM Integration
Zapier OAuth2 Authorization
Zapier Integrations
ZapierWebhookController_
1
EmployeeProposalTemplate
EmployeeJobPost
JobSearchOccupation
JobSearchCategory
EmployeeJobPreset
JobSearchPreset
KnowledgeBase
KnowledgeBaseArticle
KnowledgeBaseArticleVersion
KnowledgeBaseAuthor
Video Plugin
Camshot Plugin
Soundshot Plugin
Plugins - User Assignment
Plugin Settings
Plugin Subscriptions
Plugin Subscription Access
Plugin Subscription Plans
Plugin Billing
Plugins - Tag Management
Plugins - Recommendations
Plugin Installation
Plugin Installation Management
Plugin Sources
Plugin Versions
Plugin Registry
Plugin Management
Plugin Security
Tags - Plugin Management
Plugin Tags
Plugin Categories
Users - Plugin Assignment
Plugins - User Assignment Management
Plugin Analytics
Plugin Subscription Analytics
Plugin Tenant Management
User Subscribed Plugins
App
Health
EmailCheck
EmployeeAward
Candidate
CandidateDocument
CandidateSource
CandidateEducation
CandidateExperience
CandidateSkill
CandidateFeedback
CandidateInterview
CandidateInterviewer
CandidatePersonalQuality
CandidateTechnology
CandidateCriterionRating
Download
Import
Import History
EmployeeSetting
EmployeeAppointment
AppointmentEmployee
OrganizationDepartment
OrganizationPositions
Project Modules
OrganizationAward
OrganizationLanguage
OrganizationTeamJoinRequest
Invite
OrganizationDocument
Country
Currency
OfficialHoliday
TimeOffBalance
TimeOffPolicy
TimeOffRequest
RequestApproval
EquipmentSharing
ApprovalPolicy
EquipmentSharingPolicy
Billing
TagTypes
Skills
Languages
Invoice
EstimateEmail
InvoiceItem
Payment
PayrollRun
Goals
GoalTimeFrame
GoalGeneralSetting
KeyResults
KeyResultsUpdate
EmployeeLevel
EventType
AvailabilitySlots
Pipeline
Deal
InvoiceEstimateHistory
Equipment
Task Priority
Task RelatedIssueTypes
Task Size
Task Status
Task Version
Daily Plan
Screening Tasks
OrganizationEmploymentType
Custom Tracking
TimeSheet
TimesheetProjectChangeRequest
Report Category
Report
ProductCategories
ProductTypes
Product
ProductVariantSetting
ProductVariantPrice
ProductOption
ProductVariant
ImageAsset
GoalKpi
GoalTemplates
keyResultTemplate
GoalKpiTemplate
Accounting Template
Warehouses
Merchants
GauzyCloud
PublicEmployee
PublicInvoice
PublicOrganization
PublicTeam
EmailReset
Issue Type
Task Metadata
Linked Issue
OrganizationTaskSetting
Task Estimation
Favorites
Stats
Reactions
Comments
Mention
EntitySubscriptions
ActivityLog
ApiCallLog
Resource Links
Dashboard
Dashboard Widget
SharedEntity
Broadcast
OrganizationStrategicInitiative
Models
Object
RolePermission
CreateRolePermissionDTO
UpdateRolePermissionDTO
Role
CreateRoleDTO
CreateAiProviderCredentialDTO
ConnectAiProviderCredentialDTO
UpdateAiProviderCredentialDTO
UploadDocumentsDTO
ReplaceDocumentFileDTO
ReprocessDocumentDTO
KnowledgeSearchDTO
BulkKnowledgeReindexDTO
ReindexDocumentKnowledgeDTO
RequestReviewDTO
ApproveReviewDTO
RejectReviewDTO
UpdateExtractedTextDTO
CreateDocumentDTO
Document
BulkDocumentActionDTO
UpdateDocumentDTO
UpdateDocumentContentMetadataDTO
UpdateDocumentContentDTO
ReorderDocumentsDTO
MoveDocumentDTO
DuplicateDocumentDTO
CreateDocumentCategoryDTO
DocumentCategory
UpdateDocumentCategoryDTO
MergeDocumentCategoryDTO
CreateDocumentShareDTO
DocumentShare
UpdateDocumentShareDTO
CreateDocumentLinkDTO
DocumentLink
DocumentSettingsDTO
CreateDocumentInboundAddressDTO
DocumentInboundAddressQueryDTO
UpdateDocumentInboundAddressDTO
Feature
CreateFeatureToggleDTO
CreateTenantSettingDTO
WasabiS3ProviderConfigDTO
PreferredUiEnum
UiPreferencesConfigDTO
Changelog
SetupActivepiecesIntegrationDto
CreateActivepiecesIntegrationDto
ActivepiecesMcpToolDto
ActivepiecesMcpUpdateDto
IntegrationTenant
IntegrationEntitySetting
UpdateIntegrationTenantDTO
UpdateIntegrationSettingDTO
IntegrationSetting
IntegrationEntitySettingTied
TaskAdvancedFilterDTO
IssueType
Task
CreateTaskDTO
UpdateTaskDTO
User
UpdatePreferredLanguageDTO
UpdatePreferredComponentLayoutDTO
AiChatUiPreferencesDTO
UpdateUserUiPreferencesDTO
CreateUserDTO
UpdateUserDTO
Employee
EmployeeBulkInputDTO
UserInputDTO
CreateEmployeeDTO
UpdateEmployeeDTO
UpdateProfileDTO
TenantOrganizationBaseDTO
CustomSmtp
ValidateCustomSmtpDTO
CreateCustomSmtpDTO
UpdateCustomSmtpDTO
EmailTemplate
EmailTemplatePreviewDTO
SaveEmailTemplateDTO
CreateEmailTemplateDTO
Organization
CreateOrganizationDTO
UpdateOrganizationDTO
CreateTenantDTO
UpdateTenantDTO
TermsAcceptanceClaimDTO
RegisterUserDTO
UserLoginDTO
UserSigninWorkspaceDTO
FindUserBySocialLoginDTO
SocialLoginBodyRequestDTO
UserEmailDTO
WorkspaceSigninEmailVerifyDTO
WorkspaceSigninDTO
ChangePasswordRequestDTO
ResetPasswordRequestDTO
RefreshTokenDto
SwitchWorkspaceDTO
SwitchOrganizationDTO
ConfirmEmailByTokenDTO
ConfirmEmailByCodeDTO
AppIntegrationConfigDTO
OrganizationTeam
OrganizationProject
CreateOrganizationTeamDTO
UpdateOrganizationTeamDTO
CreateOAuthClientDTO
UpdateOAuthClientDTO
EmailHistory
UpdateEmailHistoryDTO
ResendEmailHistoryDTO
Contact
UpdateTeamMemberDTO
UpdateOrganizationTeamActiveTaskDTO
StartTimerDTO
StopTimerDTO
CreateManualTimeLogDTO
UpdateManualTimeLogDTO
UpdateTaskModeDTO
UpdateProjectSettingDTO
CountQueryDTO
RelationsQueryDTO
CreateOrganizationProjectDTO
UpdateOrganizationProjectDTO
Tag
OrganizationVendor
ExpenseCategory
Payment
Income
TimeLog
OrganizationContact
Expense
EquipmentSharingPolicy
EquipmentSharing
Equipment
ProductOptionGroupTranslation
ProductOptionGroup
ProductOptionTranslation
ProductOption
ProductVariant
WarehouseProductVariant
WarehouseProduct
Warehouse
ImageAsset
ProductTypeTranslation
ProductType
ProductCategoryTranslation
ProductCategory
ProductTranslation
Product
InvoiceItem
InvoiceEstimateHistory
Invoice
CreateOrganizationContactDTO
UpdateOrganizationContactDTO
UpdateTimeSlotDTO
BulkActivityInputDTO
TimeTrackingStatisticQueryDTO
OrganizationSprint
CreateOrganizationSprintDTO
UpdateOrganizationSprintDTO
TaskView
CreateViewDTO
UpdateViewDTO
EmployeeNotification
EmployeeNotificationSetting
CreateEmployeeNotificationSettingDTO
UpdateEmployeeNotificationSettingDTO
CreateTagDTO
UpdateTagDTO
IntegrationType
GithubInstallStateDTO
GithubAppInstallDTO
GithubOAuthDTO
ProcessGithubIssueSyncDTO
UpdateGithubRepositoryDTO
Screenshot
UpdateMakeComSettingsDTO
SetZoneDTO
CreateExpenseCategoryDTO
UpdateExpenseCategoryDTO
CreateExpenseDTO
UpdateExpenseDTO
OrganizationRecurringExpense
EmployeeRecurringExpense
CreateEmployeeRecurringExpenseDTO
UpdateEmployeeRecurringExpenseDTO
CreateIncomeDTO
UpdateIncomeDTO
Proposal
CreateProposalDTO
UpdateProposalDTO
ConfigurePlaneIntegrationDto
UpdatePlaneSettingsDto
GenerateApiKeyDTO
EverAsyncUserMappingDto
ConfigureEverAsyncIntegrationDto
UpdateEverAsyncSettingsDto
VerifyEverAsyncConnectionDto
ConfigureSimIntegrationDto
ExecuteWorkflowDto
EventMappingDto
ZapierWebhookSubscription
EmployeeProposalTemplate
ProposalTemplateDTO
CreateProposalTemplateDTO
UpdateProposalTemplateDTO
EmployeeJobPost
EmployeeJobStatisticDTO
JobPreset
SaveJobPresetCriterionDTO
SaveEmployeePresetDTO
JobPresetUpworkJobSearchCriterion
CreateJobPresetDTO
HelpCenter
HelpCenterArticle
UpdateHelpCenterArticleDTO
HelpCenterArticleVersion
HelpCenterAuthor
Video
FileDTO
CreateVideoDTO
UpdateVideoDTO
CreateCamshotDTO
Camshot
FindOptionsQueryDTO
CreateSoundshotDTO
Soundshot
AssignPluginUsersDTO
UnassignPluginUsersDTO
CreatePluginSettingDTO
Plugin_
1
PluginCategory
PluginSetting
PluginSubscription_
1
PluginTenant_
1
BulkUpdatePluginSettingsDTO
PurchasePluginSubscriptionDTO
UpdatePluginSubscriptionDTO
PluginSubscriptionAccessResponseDTO
CheckPluginSubscriptionAccessDTO
AssignPluginSubscriptionDTO
RevokePluginSubscriptionAssignmentDTO
CreatePluginSubscriptionPlanDTO
PluginSubscriptionPlan_
1
CreateMultiplePluginPlansDTO
UpdatePluginSubscriptionPlanDTO
CopyPluginPlanDTO
BulkPluginPlanOperationDTO
PluginPlanAnalyticsDTO
CreatePluginBillingDTO
UpdatePluginBillingDTO
PluginTag
ReplacePluginTagsDTO
InstallPluginDTO
PluginSource_
1
PluginInstallation_
1
PluginVersion_
1
PluginSourceDTO
CreatePluginSourceDTO
PluginVersionDTO
UpdatePluginSourceDTO
UpdatePluginVersionDTO
CreatePluginDTO
UpdatePluginDTO
VerifyPluginDTO
CreatePluginTagDTO
UpdatePluginTagDTO
BulkCreatePluginTagDTO
BulkDeletePluginTagDTO
CreatePluginCategoryDTO
UpdatePluginCategoryDTO
CreatePluginTenantDTO
ManagePluginTenantUsersDTO
UpdatePluginTenantDTO
PluginTenantConfigurationDTO
PluginTenantApprovalDTO
PluginTenantBulkOperationDTO
CheckEmailDTO
EmployeeAward
CreateEmployeeAwardDTO
UpdateEmployeeAwardDTO
CandidateBulkInputDTO
Candidate
CreateOrganizationEmploymentTypeDTO
CreateOrganizationDepartmentDTO
CreateCandidateDTO
UpdateCandidateDTO
CandidateDocument
CandidateSource
CreateCandidateSourceDTO
UpdateCandidateSourceDTO
CandidateEducation
CreateCandidateEducationDTO
UpdateCandidateEducationDTO
CandidateExperience
CreateCandidateExperienceDTO
UpdateCandidateExperienceDTO
CandidateSkill
CreateCandidateSkillDTO
UpdateCandidateSkillDTO
CandidateTechnologies
CandidatePersonalQualities
CandidateCriterionsRating
CandidateFeedback
CandidateInterviewers
CandidateInterview
EmployeeSetting
CreateEmployeeSettingDTO
UpdateEmployeeSettingDTO
EmployeeAppointment
AppointmentEmployee
OrganizationDepartment
OrganizationPosition
UpdateOrganizationPositionDTO
OrganizationProjectModule
CreateOrganizationProjectModuleDTO
UpdateOrganizationProjectModuleDTO
OrganizationAward
Language
OrganizationLanguage
ValidateJoinRequestDTO
OrganizationTeamJoinRequest
CreateInviteDTO
Invite
ResendInviteDTO
ValidateInviteByCodeQueryDTO
AcceptInviteUserDTO
AcceptInviteDTO
RejectInviteDTO
AcceptOrganizationContactInviteDTO
OrganizationDocument
Country
Currency
CreateOfficialHolidayDTO
UpdateOfficialHolidayDTO
AllocateTimeOffBalanceDTO
AdjustTimeOffBalanceDTO
CarryForwardTimeOffBalanceDTO
TimeOffPolicy
TimeOffRequest
ApprovalPolicy
RequestApproval
CreateApprovalPolicyDTO
UpdateApprovalPolicyDTO
UpdateOrCreateEquipmentSharingPolicyDTO
TagType
CreateTagTypeDTO
UpdateTagTypeDTO
CreateInvoiceDTO
UpdateInvoiceDTO
UpdateEstimateInvoiceDTO
UpdateInvoiceActionDTO
InvoiceItemBulkInputDTO
CreatePaymentDTO
UpdatePaymentDTO
CreatePayrollRunDTO
UpdatePayrollRunDTO
CreatePayrollItemDTO
CreateGoalDTO
GoalKPI
Goal
KeyResultUpdate
KeyResult
UpdateGoalDTO
CreateGoalTimeFrameDTO
GoalTimeFrame
UpdateGoalTimeFrameDTO
CreateGoalGeneralSettingDTO
GoalGeneralSetting
UpdateGoalGeneralSettingDTO
CreateKeyResultDTO
KeyResultBulkInputDTO
UpdateKeyResultDTO
CreateKeyresultUpdateDTO
UpdateKeyresultUpdateDTO
EmployeeLevel
EventType
AvailabilitySlot
UpdatePipelineDTO
Deal
CreateEquipmentDTO
UpdateEquipmentDTO
ReorderDTO
ReorderRequestDTO
UpdatesStatusDTO
DailyPlan
RemoveTaskFromManyPlansDTO
CreateDailyPlanDTO
UpdateDailyPlanDTO
ScreeningTask
CreateScreeningTaskDTO
UpdateScreeningTaskDTO
OrganizationEmploymentType
ProcessTrackingDataDTO
CustomTrackingBulkInputDTO
UpdateTimesheetStatusDTO
SubmitTimesheetStatusDTO
RequestTimesheetProjectChangeDTO
ReviewTimesheetProjectChangeDTO
Function
ProductCategoryDTO
ProductTypeDTO
CreateProductDTO
UpdateProductDTO
UploadImageAsset
GoalTemplate
GoalKPITemplate
KeyResultTemplate
CreateKeyresultTemplateDTO
AccountingTemplate
AccountingTemplatePreviewRequestDTO
AccountingTemplatePreviewDTO
SaveAccountingTemplateDTO
CreateWarehouseDTO
UpdateWarehouseDTO
Merchant
CreateMerchantDTO
UpdateMerchantDTO
PublicEstimateUpdateDTO
ResetEmailRequestDTO
VerifyEmailResetRequestDTO
UpdateIssueTypeDTO
TaskLinkedIssue
CreateTaskLinkedIssueDTO
UpdateTaskLinkedIssueDTO
OrganizationTaskSetting
CreateOrganizationTaskSettingDTO
UpdateOrganizationTaskSettingDTO
CreateTaskEstimationDTO
UpdateTaskEstimationDTO
CreateFavoriteDTO
Favorite
Reaction
CreateReactionDTO
UpdateReactionDTO
Comment
CreateCommentDTO
UpdateCommentDTO
EntitySubscription
CreateEntitySubscriptionDTO
EntitySubscriptionFindInputDTO
ResourceLink
CreateResourceLinkDTO
UpdateResourceLinkDTO
Dashboard
CreateDashboardDTO
UpdateDashboardDTO
DashboardWidget
CreateDashboardWidgetDTO
UpdateDashboardWidgetDTO
SharedEntity
CreateSharedEntityDTO
UpdateSharedEntityDTO
Broadcast
CreateBroadcastDTO
UpdateBroadcastDTO
OrganizationStrategicInitiative
CreateOrganizationStrategicInitiativeDTO
UpdateOrganizationStrategicInitiativeDTO
UpdateOrganizationStrategicSignalsDTO
Support
GitHub
Models
CheckEmailDTO
object
email
string
required
Email address to check for existence
Example
test@example.com
Copy
Copy
← Previous
PluginTenantBulkOperationDTO
Next →
EmployeeAward
Copyright © 2023-Present Ever Co. LTD.
Docs by Sourcey
Stack Overflow
Website
Demo
