API Data Provider - Online Help

Hubstaff Tables

The provider models the data in API into a list of tables that can be queried using standard SQL statements.

Generally, querying API tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Hubstaff Tables

Name Description
AttendanceSchedules Returns a collection of attendance schedules. The date filter will match schedules that cover the dates (StartDate and RepeatUntil)
AttendanceShifts Returns a collection of attendance shifts. The date filter will match shifts that cover the dates
AuthenticatedUser Returns the authenticated user.
ClientBudget Returns the budget histories for the given client.
ClientInvoices Returns a collection of client invoices.
Clients Returns a collection of clients.
Holidays Returns a collection of holidays.
JobSites Returns a collection of job sites.
OrganizationActivities Returns a collection of activities for a given organization and time slot range. Date range limit: 7 days, earliest date: 6 full months
OrganizationAppActivities Returns a collection of application activities for a given organization and time slot range. Date range limit: 7 days, earliest date: 6 full months
OrganizationBudget Returns the budget histories for the given organization..
OrganizationDailyActivities Returns a collection of daily activities. Daily activities are aggregated activities by the organization date. The daily activities can optionally be filtered to those of a given organization. Date range limit: 31 days, earliest date: 3 full years
OrganizationDailyAppActivities Returns a collection of daily application activities. Daily application activities are aggregated application activities by the organization date. The daily application activities can optionally be filtered to those of a given organization. Date range Limit: 2 weeks Earliest Date: 1 full month
OrganizationInvites Returns a collection of pending invites.
OrganizationLastActivities Retrieves the organization's last user activities.
OrganizationMembers Returns a collection of users that are a member of the given organization.
OrganizationNotes Returns a collection of notes for a given organization and time slot range. Date range Limit: 31 days, earliest date: 3 full years
Organizations Returns a collection of organizations the authenticated user is an active member of.
OrganizationScreenshots Returns a collection of screenshots for a given organization and time slot range. Date range limit: 7 days, earliest date: 6 full months
OrganizationTasks Returns a collection of tasks.
OrganizationTimeEditLogs Returns a collection of time edit logs for a given organization and created date range. Date range limit: 31 days, earliest date: 3 full years
ProjectActivities Returns a collection of activities for a given project and time slot range. Date range limit: 7 days, earliest date: 6 full months
ProjectAppActivities Returns a collection of application activities for a given project and time slot range. Date range limit: 7 days, earliest date: 6 full months
ProjectBudget Returns the budget histories for the given project.
ProjectDailyActivities Returns a collection of daily activities. Daily activities are aggregated activities by the organization date. The daily activities can optionally be filtered to those of a given organization. Date range limit: 31 days, earliest date: 3 full years
ProjectDailyAppActivities Returns a collection of daily application activities for a given project and date range. Date range limit: 2 weeks, earliest Date: 1 full month
ProjectLastActivities Returns a collection of users that are a member of the given project.
ProjectMembers Returns a collection of users that are a member of the given project.
ProjectNotes Returns a collection of notes for a given project and date range. Date range Limit: 31 days, earliest date: 3 full years
Projects Returns a collection of projects.
ProjectScreenshots Returns a collection of screenshots for a given project and time slot range. Date range limit: 7 days, earliest date: 6 full months
ProjectTasks Returns a collection of tasks for a given project.
ProjectTimeEditLogs Returns a collection of time edit logs for a given project and date range. Date range limit: 31 days, earliest date: 3 full years
TeamInvoices Returns a collection of team invoices.
TeamPayments Returns a collection of team payments. Earliest Date: 3 full years.
TimeOffPolicies Returns a collection of time off policies.
TimeOffRequests Returns a collection of time off requests.
Timesheets Returns a collection of timesheets.
User Returns the user with a given Id.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8487.0