Gauzy API
v1.0Contact: support@ever.co
Base URLs
http://localhost:3000Development Serverhttps://apidemo.gauzy.coDemo Serverhttps://api.gauzy.coProduction ServerEvery endpoint of the Ever Gauzy API, as api.gauzy.co publishes its OpenAPI document on 22 October 2026. Endpoints sit under /api on your server; most need a JWT from POST /api/auth/login, and the API overview shows how to get one and which endpoints are public.
Authentication
bearerhttpEnter JWT token
Scheme: bearer (JWT)
api-keyapiKeyAPI Key for authentication
API Key: X-API-Key in header
oauth2oauth2authorizationCode
- Authorization URL
/oauth/authorize- Token URL
/oauth/token
Scopes
read- Read accesswrite- Write accessadmin- Admin access
AI Chat
Role
- POSTImport role-permissions from self hosted to gauzy cloud hosted in bulk
- GETFind current user permissions.
- GETGet paginated records
- GETGet all records
- POSTCreate new record
- GETFind record by ID
- PUTUpdate an existing record
- DELETE/api/role-permissions/{id}
- GETGet total record count
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
- GETFind role.
- GETFind roles.
- POST/api/roles
- GETFind record by ID
- PUT/api/roles/{id}
- DELETE/api/roles/{id}
- POSTImport role from self hosted to gauzy cloud hosted in bulk
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
AI Chat Plugin
- GETList the current tenant's AI provider credentials (API keys masked).
- POSTCreate or update (upsert) an AI provider credential for the current tenant.
- POSTComplete a provider Connect flow and store the tenant's credential.
- PUTUpdate an AI provider credential.
- DELETEDelete an AI provider credential.
- GETList the current user's AI chat conversations (id, title, updatedAt).
- GETGet one of the current user's AI chat conversations, with messages.
- DELETEDelete one of the current user's AI chat conversations.
Documents Plugin
- POSTInbound-email capture webhook (signed, per-organization token).
- POSTUpload 1–10 FILE documents (multipart field `files`).
- POSTReplace the stored file of a FILE document in place (multipart field `file`).
- GETGet a short-lived download URL for a FILE document.
- GETStream the stored bytes of a FILE document.
- POSTReprocess a FILE document from the extract stage.
- POSTSearch the organization knowledge (hybrid lexical + vector, RRF).
- POSTBulk re-index the knowledge (model-drift or all).
- GETKnowledge capability status.
- POSTImport a document into AI knowledge.
- POSTExclude a document from AI knowledge.
- POSTRe-index one document into AI knowledge.
- POSTRequest a human review of a document.
- POSTApprove a pending document review.
- POSTReject a pending document review.
- POSTRegenerate the AI summary of a document.
- GETRead the extracted text of a FILE document.
- PUTSave a human-corrected extraction for a FILE document.
- GETGet org-global document stats for the hub tiles.
- GETRetrieve a paginated, filtered list of documents.
- POSTCreate a FOLDER or PAGE document.
- GETGet document count for a filter set.
- GETGet facet counts for the filter chips.
- POSTApply a bulk action to a set of documents.
- GETGet document by ID.
- PUTUpdate document metadata by ID.
- DELETESoft-delete an archived document.
- PUTSave PAGE content (optimistic concurrency + version snapshot).
- GETGet the breadcrumb path of a document (unreadable ancestors masked).
- POSTReorder sibling documents.
- POSTMove a document in the tree (cycle-guarded).
- POSTDuplicate a document (optionally deep).
- POSTArchive a document subtree.
- POSTUnarchive a document subtree.
- POSTRecover a soft-deleted document.
- GETList PAGE version snapshots (newest first).
- GETGet one full version snapshot.
- POSTRestore a version snapshot (non-destructive).
- GETList the document category catalog.
- POSTCreate a document category.
- PUTUpdate a document category.
- DELETEDelete a document category.
- POSTMerge one category into another.
- GETList links attached to one business record.
- POSTAttach a document to a business record.
- DELETEDetach a document link.
- GETList everything one document is linked to.
- GETGet the Documents org defaults and deployment capabilities.
- PUTUpdate the Documents org defaults.
- GETList the organization's inbound capture addresses.
- POSTRegister an inbound capture address on a tenant-owned domain.
- GETShow the DNS record required to verify a custom inbound domain.
- POSTCheck the DNS TXT record and verify the domain.
- POSTRotate the relay secret for an inbound address.
- POSTRotate a platform capture address to a new token.
- PUTUpdate an inbound capture address.
Feature
TenantSetting
- GETGet global settings (tenantId = NULL)
- POSTSave global settings (tenantId = NULL)
- GETGet all records
- POSTCreate new record
- GETFind record by ID
- PUTUpdate existing record
- DELETEDelete record
- POSTSave dynamic tenant settings
- POSTWasabi file storage configuration validator.
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
- GETGet the tenant-wide UI preferences (any signed-in user of the tenant).
- PUTUpdate the tenant-wide UI preferences (tenant administrators).
Changelog
ActivePieces Integration
- POSTSet up ActivePieces integration with API key
- POSTCreate or update ActivePieces connection
- GETList ActivePieces connections for a project
- GETGet ActivePieces connections for current tenant
- GETGet ActivePieces connection details
- DELETEDelete ActivePieces connection
- GETCheck if ActivePieces integration is enabled
- GETGet ActivePieces integration tenant information
ActivePieces MCP Server Integration
IntegrationsEntitySetting
IntegrationTenant
- GETRetrieve an integration tenant by specified options.
- GET/api/integration-tenant
- POSTCreate an integration tenant.
- GET/api/integration-tenant/{id}
- PUT/api/integration-tenant/{id}
- DELETE/api/integration-tenant/{id}
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
IntegrationSetting
IntegrationEntitySettingTied
Tasks
- GETGet the total count of tasks.
- GETGet tasks by pagination.
- GETGet the maximum task number by project.
- GETGet tasks assigned to the current user.
- GETGet tasks assigned to a specific employee.
- GETGet tasks assigned to the current user's team.
- GETGet tasks by module.
- GETGet tasks by start and due dates filters.
- GETGet tasks by view query filter.
- GETGet task by ID.
- PUTUpdate an existing task.
- DELETEDelete a task by ID.
- GETGet tasks assigned to a specific employee.
- GETGet all tasks.
- POSTCreate a new task.
- DELETE/api/tasks/employee/{employeeId}
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
User
- GETFind current user.
- GETFind user by email address.
- PUT/api/user/preferred-language
- PUT/api/user/preferred-layout
- PUTUpdate the current user's UI preferences (per-feature shallow merge).
- GET/api/user/count
- GET/api/user/pagination
- GETFind all users.
- POSTCreate new record
- GETFind User by id.
- PUT/api/user/{id}
- DELETEDelete record
- DELETEDelete all user data.
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
Employee
- GETFind all working employees.
- GETGet the total count of all working employees.
- POSTCreate multiple employee records in bulk
- GETGet employee count in the same tenant
- GETGet employees by pagination in the same tenant
- GETGet members of the organization
- GETFind all employees in the same tenant.
- POSTCreate a new employee in the same tenant
- GETFind employee by ID within the same tenant.
- PUTUpdate an existing employee by ID
- DELETESoft delete record
- PUTUpdate Employee Own Profile
- DELETESoft delete employee record
- PUTRestore a soft-deleted employee record
CustomSmtp
EmailTemplate
- GET/api/email-template/count
- GET/api/email-template/pagination
- GETFind email template by name and language code for organization
- POSTConverts mjml or handlebar text to html for email preview
- POSTConvert mjml or handlebar text to html
- GET/api/email-template
- POSTCreate email template in the current tenant
- GETGets template by id
- PUTUpdates template
- DELETEDelete email template
- DELETESoft delete email template
- PUTRecover soft-deleted email template
Organization
- GET/api/organization/count
- GETRetrieve paginated list of organizations within the tenant.
- GETFind all organizations within the tenant.
- POSTCreate a new Organization for a specific tenant
- GETFind Organization by ID within the tenant.
- PUTUpdate an existing Organization
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
UserOrganization
- GETFind all UserOrganizations.
- POSTAdd a user to an organization
- GETFind record by ID
- PUTUpdate a user's membership of an organization
- DELETEDelete user from organization
- DELETESoft-delete a user's membership of an organization
- PUTRestore a soft-deleted membership of an organization
- GETFind number of Organizations user belongs to
- GETGet total record count
- GETGet paginated records
Tenant
Auth
- GETCheck if user is authenticated
- GETCheck if the user has a specific role
- GETCheck if the user has specific permissions
- POSTRegister a new user
- POST/api/auth/login
- POST/api/auth/signin.email.password
- POST/api/auth/signup.link.account
- POST/api/auth/signin.email
- POST/api/auth/signin.email/confirm
- POST/api/auth/signin.workspace
- POST/api/auth/reset-password
- POST/api/auth/request-password
- POSTLogout user
- POSTRefresh token
- GETGet user workspaces
- POSTSwitch user workspace
- POSTSwitch to a different organization within the current workspace
EmailVerification
OAuthAppController_1
OrganizationTeam
- GETFind all organization Teams.
- GET/api/organization-team/count
- GET/api/organization-team/pagination
- GETFind all organization Teams.
- POSTCreate new record
- GET/api/organization-team/{id}
- PUTUpdate an organization Team
- DELETEDelete organization team
- DELETE/api/organization-team/teams/{userId}
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
OAuthClient
Contact
OrganizationTeamEmployee
Timer Tracker
TimeLog
- GETGet Timer Logs Conflict
- GETFind Timer Log by id
- GETFind Timer Log by id
- GETGet Owed Amount Report
- GETGet Owed Amount Report Chart Data
- GETGet Weekly Report
- GETGet Time Limit Report
- GETGet Project Budget Limit
- GETGet Client Budget Limit
- GETGet Timer Logs
- POSTAdd manual time
- DELETEDelete time log
- GET/api/timesheet/time-log/{id}
- PUTUpdate time log
OrganizationProject
- GETFind all organization projects by Employee.
- PUTUpdate organization project by employee
- PUTUpdate organization project task view mode
- PUTUpdate organization project settings by ID
- GETFind synced projects with pagination and optional search.
- GETFind organization projects count.
- GETFind all organization project in the same tenant using pagination.
- GETFind all organization projects.
- POSTCreate a new organization project
- GETFind organization project by ID
- PUTUpdate organization project by ID
- DELETEDelete organization project by ID
- GETCheck if an employee is a manager of a specific project.
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
EmployeeRecentVisit
OrganizationContact
- GETFind all organization contact counts in the same tenant
- GETFind all organization contacts in the same tenant using pagination.
- GETFind all organization contacts by Employee.
- PUTUpdate an existing record
- GETFind all organization contacts.
- POST/api/organization-contact
- GETGet organization contacts by id.
- PUT/api/organization-contact/{id}
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
TimeSlot
Activity
TimesheetStatistic
OrganizationSprint
Task views
EmployeeNotification
EmployeeNotificationSetting
Integrations
GitHub Integrations
GitHubIntegration
GitHubSync
GitHubRepository
Hubstaff Integrations
- GET/api/integration/hubstaff/callback
- GET/api/integration/hubstaff/token/{integrationId}
- GET/api/integration/hubstaff/refresh-token/{integrationId}
- POST/api/integration/hubstaff/integration
- GET/api/integration/hubstaff/organizations
- GET/api/integration/hubstaff/projects/{organizationId}
- POST/api/integration/hubstaff/sync-projects
- POST/api/integration/hubstaff/sync-organizations
- POST/api/integration/hubstaff/auto-sync/{integrationId}
Make.com Integrations
Make.com OAuth
Make.com API
- GETGet Make.com setup status (zone, org, team, token)
- GETGet available Make.com zones
- GETGet the configured zone for this tenant
- POSTSet the Make.com zone for this tenant
- POSTSet the Make.com organization ID for this tenant
- POSTSet the Make.com team ID for this tenant
- GETList Make.com organizations for the authenticated user
- GETGet a Make.com organization by ID
- GETList Make.com teams
- GETGet a Make.com team by ID
- GETList Make.com connections
- GETGet a Make.com connection by ID
- DELETEDelete a Make.com connection
- POSTTest a Make.com connection
- GETList Make.com scenarios
- POSTCreate a Make.com scenario
- GETGet a Make.com scenario by ID
- DELETEDelete a Make.com scenario
- PATCHUpdate a Make.com scenario
- POSTActivate a Make.com scenario
- POSTDeactivate a Make.com scenario
- POSTRun a Make.com scenario on demand
- GETList Make.com hooks (webhooks)
- POSTCreate a Make.com hook (webhook)
- GETGet a Make.com hook by ID
- DELETEDelete a Make.com hook
- PATCHUpdate a Make.com hook name
- GETPing a Make.com hook
- POSTEnable a Make.com hook
- POSTDisable a Make.com hook
- GETList Make.com templates
- GETGet a Make.com template by ID
- GETGet the blueprint of a Make.com template
Hook
Upwork Integrations
ExpenseCategories
Expense
- GET/api/expense/count
- GET/api/expense/pagination
- GETFind all expense for the logged in employee, including split expenses.
- GETFind all expenses for an employee, including split expenses.
- GETFind all expenses for an employee, including split expenses.
- GETReport daily chart
- GETFind all expense.
- POSTCreate new record
- GET/api/expense/{id}
- PUTCreate new record
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
EmployeeStatistics
OrganizationRecurringExpense
- GETFind all organization recurring expense by month.
- GETFind start date update type & conflicting expenses for the update
- GETFind all organization recurring expenses for given employee, also known as split recurring expenses.
- GETFind all organization recurring expenses.
- POSTCreate new organization recurring expense
- GETFind record by ID
- PUTUpdate an existing record
- DELETEDelete record
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
EmployeeRecurringExpense
- GETFind all employee recurring expense by month.
- GETFind the start date update type for a recurring expense.
- GETFind all employee recurring expenses.
- POSTCreate new expense
- GETFind record by ID
- PUTUpdate an existing record
- DELETEDelete record
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
Income
OrganizationVendor
Proposal
Plane Integration
- POSTConfigure Plane integration for the current tenant.
- GETGet Plane integration settings for the current tenant.
- PUTUpdate Plane integration settings.
- DELETERemove Plane integration for the current tenant.
- POSTRegenerate Plane integration API key and secret.
- GETCheck Plane integration status for the current tenant.
TenantAPIKeys
Ever Async Integration
- POSTConnect Ever Async and return its read-only credential once.
- GET/api/integration/ever-async/settings
- PUT/api/integration/ever-async/settings
- GET/api/integration/ever-async/options
- POST/api/integration/ever-async/credentials/rotate
- POSTCheck server reachability. This does not install or authenticate a chat integration.
- GET/api/integration/ever-async/status
- DELETE/api/integration/ever-async/{integrationTenantId}
Ever Async Connector
SIM Integration
- POSTConfigure SIM integration with API key
- GETGet SIM integration settings
- POSTExecute a SIM workflow
- GETValidate a SIM workflow
- GETGet async job status
- GETGet workflow execution history
- GETCheck if SIM integration is enabled
- GETGet SIM integration tenant information
- GETGet supported event types for SIM workflow triggers
- GETGet all event-to-workflow mappings
- POSTSet an event-to-workflow mapping for automatic workflow triggers
- DELETERemove an event-to-workflow mapping
Zapier Integrations
ZapierWebhookController_1
EmployeeProposalTemplate
- GETGet paginated employee proposal templates
- PATCHMake Default
- GETFind all employee proposal templates
- POSTCreate employee proposal template
- GETFind record by ID
- PUTUpdate employee proposal template
- DELETEDelete record
- GETGet total record count
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
EmployeeJobPost
- GETFind all employee job posts
- GETRetrieve employee job statistics
- PUTUpdate Job Search Status
- POSTApply for a Job
- POSTUpdate applied for a job
- POSTHide job
- POSTCreate employee job application record
- GETGet AI generated proposal for employee job application.
- POSTGenerate AI proposal for employee job application
JobSearchOccupation
JobSearchCategory
EmployeeJobPreset
JobSearchPreset
KnowledgeBase
- GETFind all menus.
- POSTCreate new category
- POSTUpdate indexes in Bulk
- GETFind Categories By Base Id.
- DELETEDelete Categories By Base Id.
- GETFind record by ID
- PUTUpdate an existing record
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
- GETGet total record count
- GETGet paginated records
KnowledgeBaseArticle
- GETGet all records
- POSTCreate new article
- POSTDuplicate an article
- GETFind articles By Category Id.
- DELETEDelete Articles By Category Id.
- GETFind articles By Project Id.
- GETGet article binary description
- PATCHAtomic update of all description fields (binary + HTML + JSON)
- PUTUpload binary description (octet-stream)
- GETFind record by ID
- PUTUpdate an existing record
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
- GETGet total record count
- GETGet paginated records
KnowledgeBaseArticleVersion
Video Plugin
Camshot Plugin
Soundshot Plugin
Plugins - User Assignment
Plugin Settings
Plugin Subscriptions
- GETGet all plugin subscriptions
- POSTCreate plugin subscription
- GETGet current user's active subscription for plugin
- GETGet plugin subscription by ID
- PUTUpdate plugin subscription
- DELETEDelete plugin subscription
- PATCHUpdate plugin subscription status
- POSTUpgrade plugin subscription to a higher plan
- POSTDowngrade plugin subscription to a lower plan
Plugin Subscription Access
Plugin Subscription Plans
- GETGet all plugin subscription plans
- POSTCreate plugin subscription plan
- POSTCreate multiple plugin subscription plans
- GETGet active plugin subscription plans
- GETGet plugin subscription plans by plugin ID
- GETGet plugin subscription plan by ID
- PUTUpdate plugin subscription plan
- DELETEDelete plugin subscription plan
- PATCHPartially update plugin subscription plan
- POSTCopy plugin subscription plan
- POSTBulk operations on plugin subscription plans
- POSTGet plugin subscription plan analytics
Plugin Billing
Plugins - Tag Management
Plugins - Recommendations
Plugin Installation
Plugin Installation Management
Plugin Sources
Plugin Versions
Plugin Management
Plugin Security
Plugin Categories
Users - Plugin Assignment
Plugins - User Assignment Management
Plugin Analytics
Plugin Subscription Analytics
Plugin Tenant Management
- GETGet All Plugin Tenants
- POSTCreate Plugin Tenant
- GETGet Plugin Tenant Statistics
- GETGet Plugin Tenants by Plugin
- GETGet Plugin Tenants by Tenant
- GETCheck Plugin Access
- GETGet Plugin Tenant by ID
- PUTUpdate Plugin Tenant
- DELETEDelete Plugin Tenant
- GETGet Plugin Tenant Quota Info
- GETGet Plugin Tenant Users
- POSTManage Plugin Tenant Users
- PATCHUpdate Plugin Tenant Configuration
- PATCHEnable Plugin Tenant
- PATCHDisable Plugin Tenant
- PATCHApprove/Reject Plugin Tenant
- PATCHBulk Update Plugin Tenants
User Subscribed Plugins
EmployeeAward
Candidate
- POSTCreate records in Bulk
- GETFind all candidates counts in the same tenant
- GETFind all candidates in the same tenant using pagination.
- GETFind all candidates in the same tenant.
- POSTCreate new record
- GETFind Candidate by id
- PUTUpdate an existing record
- DELETEDelete record
- PUTUpdate candidate status (Hired/Rejected)
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
CandidateDocument
CandidateSource
CandidateEducation
CandidateExperience
CandidateSkill
CandidateFeedback
- GETFind feedbacks By Interview Id.
- DELETE/api/candidate-feedbacks/interview/{interviewId}/{feedbackId}
- GETFind all candidate feedbacks counts in the same tenant
- GETFind all candidate feedbacks in the same tenant using pagination.
- GETFind all candidate feedback.
- POST/api/candidate-feedbacks
- GETFind candidate feedback by id
- PUT/api/candidate-feedbacks/{id}
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
CandidateInterview
- GETFind interview by candidate id
- GETFind all candidate interviews count in the same tenant
- GETFind all candidate interviews in the same tenant using pagination.
- GETFind all candidate interview.
- POSTCreate new record interview
- GETFind candidate interview by id
- PUT/api/candidate-interview/{id}
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
CandidateInterviewer
- POSTCreate interviewers in Bulk
- GETFind Interviewers By Interview Id.
- DELETEDelete Interviewers By Interview Id.
- DELETEDelete Interviewers By employeeId.
- GETFind all candidate interviewers.
- POSTCreate new record interviewers
- GETGet total record count
- GETGet paginated records
- GETFind record by ID
- PUTUpdate existing record
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
CandidatePersonalQuality
- GET/api/candidate-personal-qualities/interview/{interviewId}
- DELETE/api/candidate-personal-qualities/bulk/{id}
- POST/api/candidate-personal-qualities/bulk
- GETFind all candidate personal qualities.
- POST/api/candidate-personal-qualities
- GETFind record by ID
- PUTUpdate existing record
- DELETE/api/candidate-personal-qualities/{id}
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
CandidateTechnology
- POST/api/candidate-technologies/bulk
- PUT/api/candidate-technologies/bulk
- GET/api/candidate-technologies/interview/{interviewId}
- DELETE/api/candidate-technologies/bulk/{id}
- GETFind all candidate technologies.
- POST/api/candidate-technologies
- GETFind record by ID
- PUTUpdate existing record
- DELETE/api/candidate-technologies/{id}
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
CandidateCriterionRating
- POST/api/candidate-criterions-rating/bulk
- PUT/api/candidate-criterions-rating/bulk
- GETFind all candidate criterion rating.
- POSTCreate new record
- DELETE/api/candidate-criterions-rating/feedback/{feedbackId}
- GETGet total record count
- GETGet paginated records
- GETFind record by ID
- PUTUpdate existing record
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
EmployeeSetting
EmployeeAppointment
- GETSign appointment id payload
- GETVerify token
- GET/api/employee-appointment/pagination
- GETFind all employee appointments
- POSTCreate new record
- GETFind Employee appointment by id.
- PUTUpdate an existing record
- DELETEDelete record
- GETGet total record count
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
AppointmentEmployee
- GETFind appointment employees by appointment id.
- GETFind appointments based on employee id.
- GETGet total record count
- GETGet paginated records
- GETGet all records
- POSTCreate new record
- GETFind record by ID
- PUTUpdate existing record
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
OrganizationDepartment
- GETFind all organization departments.
- PUTUpdate an existing record
- GETFind all organization departments.
- POSTCreate new record
- GET/api/organization-department/pagination
- GETFind record by ID
- PUTUpdate an existing record
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
- GETGet total record count
OrganizationPositions
Project Modules
- GETFind employee project modules.
- GETFind my team project modules.
- GETFind Employee project modules.
- GETFind all project modules.
- POSTcreate a project module
- GETFind by id
- PUTUpdate an existing project module
- DELETE/api/organization-project-modules/{id}
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
OrganizationAward
OrganizationLanguage
OrganizationTeamJoinRequest
Invite
- POSTCreate email invites
- POSTResend invite.
- GETGet invite.
- POSTValidate invite by code and email.
- POSTAccept employee/user/candidate invite.
- POSTReject employee/user/candidate invite.
- POSTAccept organization contact invite.
- PUTUpdate an existing record
- GETFind all invites of current user
- GETFind all invites.
- DELETEDelete record
- PUTAccept or Reject invite of current user
OrganizationDocument
Country
Currency
OfficialHoliday
TimeOffBalance
TimeOffPolicy
TimeOffRequest
- GET/api/time-off-request/pagination
- PUTTime off request approved
- PUTTime off request denied
- GETFind all time off requests.
- POSTCreate new time off request / holiday record
- GETFind record by ID
- PUTTime off request update
- DELETEDelete record
- GETGet total record count
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
RequestApproval
- GETFind all request approval.
- PUTemployee accept request approval.
- PUTemployee refuse request approval.
- GETFind all request approvals.
- POSTcreate a request approval.
- GETFind record by ID
- PUTupdate a request approval.
- DELETEDelete record
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
EquipmentSharing
- GETFind equipment sharings By Organization Id
- POSTCreate an new record
- GETFind equipment sharings By Employee Id
- PUTequipment sharings request approval
- PUTequipment sharings request refuse
- GET/api/equipment-sharing/pagination
- GETFind all equipment sharings
- POSTCreate new record
- GETFind record by ID
- PUTUpdate an existing record
- DELETEDelete record
- GETGet total record count
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
ApprovalPolicy
- GETFind all approval policies except time off and equipment sharing policy.
- GET/api/approval-policy/pagination
- GETFind all approval policies.
- POSTCreate new record
- GETFind record by ID
- PUTUpdate record
- DELETEDelete record
- GETGet total record count
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
EquipmentSharingPolicy
- GETGet equipment sharing policies by pagination
- GETFind all equipment sharing policies
- POSTCreate a new Equipment Sharing Policy record
- GETFind record by ID
- PUTUpdate an existing Equipment Sharing Policy record
- DELETEDelete record
- GETGet total record count
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
Billing
- GETWhether billing is configured on this deployment
- GETThe tenant's current subscription
- GETPlans this tenant can switch to
- POSTSwitch the subscription to another plan
- POSTCancel at the end of the current period
- POSTUndo a pending cancellation
- GETInvoice history
- GETThe card on file
- POSTOpen the Stripe customer portal
TagTypes
Skills
Invoice
- GET/api/invoices/count
- GET/api/invoices/pagination
- GET/api/invoices/highest
- GET/api/invoices
- POSTCreate new record
- GET/api/invoices/{id}
- PUTUpdate record
- DELETEDelete record
- PUTUpdate estimate invoice
- PUTUpdate Invoice's Status
- PUT/api/invoices/email/{email}
- PUT/api/invoices/generate/{uuid}
- GETDownload Invoice
- GETDownload Invoice
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
EstimateEmail
InvoiceItem
Payment
PayrollRun
- GETGet payroll statistics
- GETFind payroll runs
- POSTCreate a payroll run
- GETFind a payroll run by id
- PUTUpdate a payroll run
- GETGet the per-employee summary of a payroll run
- PUTSubmit a payroll run for approval
- PUTApprove a payroll run
- PUTProcess a payroll run and mark it paid
- PUTCancel a payroll run
- POSTAdd a line item to a payroll run
- DELETERemove a line item from a payroll run
Goals
GoalTimeFrame
GoalGeneralSetting
KeyResults
KeyResultsUpdate
EmployeeLevel
EventType
AvailabilitySlots
Pipeline
Deal
InvoiceEstimateHistory
Equipment
Task Priority
Task Size
Task Status
- PATCHReorder records based on given input
- GETFind all records.
- POSTCreate new record.
- PUTMake task status default.
- GETFind records count.
- GETFind all records using pagination.
- GETFind one record by id.
- PUTUpdate an existing record.
- DELETEDelete record.
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
Task Version
Daily Plan
- GETFind my daily plans.
- GETFind team daily plans.
- GETFind employee daily plans.
- GETFind task daily plans.
- POSTAdd a task to daily plan
- PUTRemove a task from daily plan
- PUTRemove a task from daily plans
- GETGet all records
- POSTCreate new Daily Plan
- GETFind record by ID
- PUTUpdate daily plan
- DELETEDelete Daily plan
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
Screening Tasks
OrganizationEmploymentType
Custom Tracking
TimeSheet
TimesheetProjectChangeRequest
Report Category
Report
ProductCategories
ProductTypes
Product
- GETFind all products translated
- GETFind one product translated
- POSTCreate gallery image
- POSTSet featured image
- DELETEDelete image from gallery
- DELETEDelete featured image
- GETFind Products Count
- GET/api/products/pagination
- GETFind all products
- POSTCreate new record
- GETFind Product by id
- PUTUpdate an existing record
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
ProductVariantSetting
ProductVariantPrice
ProductOption
ProductVariant
- GETFind all variants by product id
- POSTCreate product variants
- GETFind all product variants
- POSTCreate new record
- GETFind all product variants
- PUTUpdate an existing record
- DELETEDelete record
- DELETEDelete featured image
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
ImageAsset
- POST/api/image-assets/upload/{folder}
- GETFind all image assets counts in the same tenant
- GETFind all image assets in the same tenant using pagination.
- GET/api/image-assets
- POST/api/image-assets
- GET/api/image-assets/{id}
- PUTUpdate existing record
- DELETE/api/image-assets/{id}
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
GoalKpi
GoalTemplates
keyResultTemplate
GoalKpiTemplate
Accounting Template
- GET/api/accounting-template/count
- GET/api/accounting-template/pagination
- GETFind template by name and language code for organization
- POSTConverts mjml or handlebar text to html for template preview
- POSTConverts mjml or handlebar text to html for template preview
- GET/api/accounting-template
- POSTCreate new record
- GETGets template by id
- PUTUpdates template
- DELETEDelete accounting template
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
Warehouses
- GETFind all warehouse products.
- POSTCreate warehouse products
- POSTUpdate warehouse product quantity.
- POSTUpdate warehouse product variant count.
- GETFind all warehouse count in the same tenant
- GET/api/warehouses/pagination
- GETFind all warehouses.
- POST/api/warehouses
- GET/api/warehouses/{id}
- PUTUpdate an existing warehouse
- DELETEDelete record
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
Merchants
GauzyCloud
PublicEmployee
PublicOrganization
PublicTeam
Issue Type
Task Metadata
Linked Issue
OrganizationTaskSetting
Task Estimation
Favorites
- GETGet all records
- POSTCreate element favorite
- GETFind favorite entity records By current Employee
- GETFind favorite entity records.
- GETFind record by ID
- PUTUpdate existing record
- DELETEDelete Favorite
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
Stats
Reactions
Comments
Mention
EntitySubscriptions
ActivityLog
ApiCallLog
Resource Links
Dashboard
Dashboard Widget
Broadcast
OrganizationStrategicInitiative
- GETFind all organization strategic initiatives with optional filters
- POSTCreate a new organization strategic initiative
- GETFind organization strategic initiatives by project
- GETFind an organization strategic initiative by ID
- PUTUpdate an organization strategic initiative
- DELETEDelete an organization strategic initiative
- PUTUpdate strategic signals of an organization strategic initiative
- GETGet total record count
- GETGet paginated records
- DELETESoft delete a record by ID
- PUTRestore a soft-deleted record by ID
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
- 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
- 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
- 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
- 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
- Broadcast
- CreateBroadcastDTO
- UpdateBroadcastDTO
- OrganizationStrategicInitiative
- CreateOrganizationStrategicInitiativeDTO
- UpdateOrganizationStrategicInitiativeDTO
- UpdateOrganizationStrategicSignalsDTO