invantive documentation
Invantive Support ForumsLog In / Sign Up

Freshservice Data Model

Authentication Authentication can be done using one of the following two alternatives:

  1. Using the user log on code, password and company also used on the Freshservice website.
  2. Using an API key and company. Authentication using user log on code and password is recommended for general use. The company is the name before '.freshservice.com' in the URL used to log on to Freshservice in a browser. The API key can be found in the 'Edit Profile' page in Freshservice, as described on https://support.freshservice.com/support/solutions/articles/225435-where-can-i-find-my-api-key.

API Version The V2 API of Freshservice is used. V1 APIs can be accessed using NativePlatformScalarRequests.

Usage Limits Invantive SQL executes API calls to retrieve and upload data. The number of API calls allowed per hour depends on your Freshservice plan, API version and whether you have chosen for rate limits per minute (most recent) or hour (older). The V1 API default usage limit is 1.000 calls per hour. On V2 the limit is 3.000 (blossom, garden) or 5.000 (estate, forest) calls per hour. The new V2 limits are 100 (blossom), 200 (garden), 400 (estate) or 700 (forest) calls per minute. Increased limits can be purchased. Invantive SQL ensures that within your session the number of calls allowed per hour is not exceeded. To get an impression of how Invantive SQL translates into API calls, please query the data dictionary view 'sessionios', such as with 'select * from sessionios@datadictionary'.

Set up this platform in Invantive Cloud: https://cloud.invantive.com/freshservice

Text comparisons on this platform are case sensitive.

Platform

  • Used from: Invantive Cloud and the Invantive products on your own computer or server.
  • Kind: an application reached over its API.
  • The data is partitioned, such as per company or administration.
  • Data can be written as well as read.
  • Invantive Cloud plans: Free for Exact Online, Free, Office for Entrepreneurs, Office for Accountants, Premium Finance, OEM.
  • Status of the platform: https://updates.freshservice.com/.

Figures

Figure Count
Tables 73
Columns 928

Data Model Poster

This data model declares no keys yet; the dotted relations are derived from column names.

PDF, 1 A0 sheet

On a table of the poster: plus and minus zoom, the arrow keys move, 0 fits.

Freshservice data model, Sheet 1 of 1Freshservice data modelfor use with Invantive UniversalSQLRelease 24.0.491-PROD+5130 · 11-12-2024Freshservice · Departments · Freshservice · WorkspacesSheet 1 of 1 · documentation.invantive.euFreshservice · DepartmentsFreshservice.Freshservice.AgentRoles: Agent RolesAgentRolesFreshservice.Freshservice.AgentWorkspaces: Agent WorkspacesAgentWorkspacesFreshservice.Freshservice.Agents: AgentsAgentsFreshservice.Freshservice.AssetSources: Asset SourcesAssetSourcesFreshservice.Freshservice.Assets: AssetsAssetsFreshservice.Freshservice.Changes: ChangesChangesFreshservice.Freshservice.Contracts: ContractsContractsFreshservice.Freshservice.Departments: DepartmentsDepartmentsFreshservice.Freshservice.Locations: LocationsLocationsFreshservice.Freshservice.Problems: ProblemsProblemsFreshservice.Freshservice.PurchaseOrders: Purchase OrdersPurchaseOrdersFreshservice.Freshservice.RecentTickets: Tickets (Recent)RecentTicketsFreshservice.Freshservice.Releases: ReleasesReleasesFreshservice.Freshservice.Requesters: RequestersRequestersFreshservice.Freshservice.TicketsIncremental: Tickets (Incremental)TicketsIncrementalFreshservice.Freshservice.Vendors: VendorsVendorsFreshservice.Freshservice.Workspaces: WorkspacesWorkspacesFreshservice · WorkspacesFreshservice · WorkspacesFreshservice.Freshservice.AgentGroups: Agent GroupsAgentGroupsFreshservice.Freshservice.Announcements: AnnouncementsAnnouncementsFreshservice.Freshservice.Applications: ApplicationsApplicationsFreshservice.Freshservice.BusinessHours: Business HoursBusinessHoursFreshservice.Freshservice.CannedResponses: Canned ResponsesCannedResponsesFreshservice.Freshservice.ProblemFormFields: Problem Form FieldsProblemFormFieldsFreshservice.Freshservice.Products: ProductsProductsFreshservice.Freshservice.ServiceCategories: Service CategoriesServiceCategoriesFreshservice.Freshservice.ServiceItems: Service ItemsServiceItemsFreshservice.Freshservice.SlaPolicies: SLA PoliciesSlaPoliciesFreshservice.Freshservice.SolutionCategories: Solution CategoriesSolutionCategoriesFreshservice.Freshservice.Workspaces: WorkspacesWorkspacesCodeValuesFreshservice.CodeValues.ApplicationStatuses: Domain ApplicationStatusesApplicationStatusesFreshservice.CodeValues.ApplicationTypes: Domain ApplicationTypesApplicationTypesFreshservice.CodeValues.ApprovalStatuses: Domain ApprovalStatusesApprovalStatusesFreshservice.CodeValues.ApprovalTypes: Domain ApprovalTypesApprovalTypesFreshservice.CodeValues.AssetImpacts: Domain AssetImpactsAssetImpactsFreshservice.CodeValues.AssetUsageTypes: Domain AssetUsageTypesAssetUsageTypesFreshservice.CodeValues.BackgroundJobStatuses: Domain BackgroundJobStatusesBackgroundJobStatusesFreshservice.CodeValues.ChangeImpacts: Domain ChangeImpactsChangeImpactsFreshservice.CodeValues.ChangePriorities: Domain ChangePrioritiesChangePrioritiesFreshservice.CodeValues.ChangeRisks: Domain ChangeRisksChangeRisksFreshservice.CodeValues.ChangeStatuses: Domain ChangeStatusesChangeStatusesFreshservice.CodeValues.ChangeTypes: Domain ChangeTypesChangeTypesFreshservice.CodeValues.ConversationSourceTypes: Domain ConversationSourceTypesConversationSourceTypesFreshservice.CodeValues.CustomFieldTypes: Domain CustomFieldTypesCustomFieldTypesFreshservice.CodeValues.LookupDatasources: Domain LookupDatasourcesLookupDatasourcesFreshservice.CodeValues.OffboardingRequestStatuses: Domain OffboardingRequestStatusesOffboardingRequestStatusesFreshservice.CodeValues.OnboardingRequestStatuses: Domain OnboardingRequestStatusesOnboardingRequestStatusesFreshservice.CodeValues.ProductProcurementModes: Domain ProductProcurementModesProductProcurementModesFreshservice.CodeValues.ProductStatuses: Domain ProductStatusesProductStatusesFreshservice.CodeValues.ProjectPriorities: Domain ProjectPrioritiesProjectPrioritiesFreshservice.CodeValues.ProjectStatuses: Domain ProjectStatusesProjectStatusesFreshservice.CodeValues.ProjectTypes: Domain ProjectTypesProjectTypesFreshservice.CodeValues.ProjectVisibilities: Domain ProjectVisibilitiesProjectVisibilitiesFreshservice.CodeValues.ServiceRequestStages: Domain ServiceRequestStagesServiceRequestStagesFreshservice.CodeValues.SolutionFolderVisibilities: Domain SolutionFolderVisibilitiesSolutionFolderVisibilitiesFreshservice.CodeValues.TicketPriorities: Domain TicketPrioritiesTicketPrioritiesFreshservice.CodeValues.TicketSourceTypes: Domain TicketSourceTypesTicketSourceTypesFreshservice.CodeValues.TicketStatuses: Domain TicketStatusesTicketStatusesFreshserviceFreshservice.Freshservice.AgentGroupMembers: Agent Group MembersAgentGroupMembersFreshservice.Freshservice.AssetTypes: Asset TypesAssetTypesFreshservice.Freshservice.BusinessHourHolidays: Business Hour HolidaysBusinessHourHolidaysFreshservice.Freshservice.CABs: CABsCABsFreshservice.Freshservice.ContractTypes: Contract TypesContractTypesFreshservice.Freshservice.ProblemFormFieldChoices: Problem Form Field ChoicesProblemFormFieldChoicesFreshservice.Freshservice.ProjectTemplates: Project TemplatesProjectTemplatesFreshservice.Freshservice.ProjectsNewGen: Projects (New Gen)ProjectsNewGenFreshservice.Freshservice.RelationshipTypes: Relationship TypesRelationshipTypesFreshservice.Freshservice.Relationships: RelationshipsRelationshipsFreshservice.Freshservice.RequesterGroups: Requester GroupsRequesterGroupsFreshservice.Freshservice.StatisticsIncremental: Statistics on Incremental TablesStatisticsIncrementalNativeFreshservice.Native.NATIVEPLATFORMSCALARREQUESTS: Native Platform Scalar RequestsNATIVEPLATFORMSCALARREQUESTSViewsFreshservice.Views.RequesterGroupMembersRequesterGroupMembersFreshserviceAuthentication Authentication can be done using one of thefollowing two alternatives: 1. Using the user log on code,password and company also used on the Freshservice website.2. Using an API key and company. Authentication using userlog on code and password is recommended for general use.The company is the name before '.freshservice.com' in the URLNotesThis data model declares no keys yet; the dotted relations are derived from column names.Data dictionaryEvery table and column of this data model is described with its documentation ondocumentation.invantive.eu, where the poster is also available in other languages.NotesThe boxes are grouped by topic and coloured by category. A relation is drawn in the topic of thetable holding the key; a box in pale grey is defined in another topic.TopicsFreshservice · Departments1Freshservice · Workspaces1Tables without relations1LegendTransactionalSetupTechnicalHard-coded valuesDefined in another topicDeclared keyRelation described in wordsCandidate derived from column namesBold: a popular table+Bulk, +Read: the table also exists as these variants×n: n keys between the same tablesGenerated from the metadata of Invantive UniversalSQL 24.0.491-PROD+5130 on 11-12-2024. Every table links toits page with columns, keys and sample queries.documentation.invantive.eu/en/datamodels/freshservice
The poster as text: tables per topic and their relations

Freshservice · Departments

AgentRoles, AgentWorkspaces, Agents, AssetSources, Assets, Changes, Contracts, Departments, Locations, Problems, PurchaseOrders, RecentTickets, Releases, Requesters, TicketsIncremental, Vendors

Freshservice · Workspaces

AgentGroups, Announcements, Applications, BusinessHours, CannedResponses, ProblemFormFields, Products, ServiceCategories, ServiceItems, SlaPolicies, SolutionCategories, Workspaces

CodeValues (without relations)

ApplicationStatuses, ApplicationTypes, ApprovalStatuses, ApprovalTypes, AssetImpacts, AssetUsageTypes, BackgroundJobStatuses, ChangeImpacts, ChangePriorities, ChangeRisks, ChangeStatuses, ChangeTypes, ConversationSourceTypes, CustomFieldTypes, LookupDatasources, OffboardingRequestStatuses, OnboardingRequestStatuses, ProductProcurementModes, ProductStatuses, ProjectPriorities, ProjectStatuses, ProjectTypes, ProjectVisibilities, ServiceRequestStages, SolutionFolderVisibilities, TicketPriorities, TicketSourceTypes, TicketStatuses

Freshservice (without relations)

AgentGroupMembers, AssetTypes, BusinessHourHolidays, CABs, ContractTypes, ProblemFormFieldChoices, ProjectTemplates, ProjectsNewGen, RelationshipTypes, Relationships, RequesterGroups, StatisticsIncremental

Native (without relations)

NATIVEPLATFORMSCALARREQUESTS

Views (without relations)

RequesterGroupMembers

Relations

Tables

Freshservice.CodeValues

Freshservice.Freshservice

Freshservice.Native

Freshservice.Views

Attributes

The attributes of this platform are on the page Attributes.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: