Connecting to Toggl
Authentication
To authenticate to Toggl, and connect to your own data or to allow other users to connect to their data, use API Key authentication.
Using API Key Authentication
Obtain your API key from your Toggl account profile settings.
Set the following connection properties:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Toggl API key.
Available Tables
The Toggl API Profile provides access to comprehensive time tracking and project management data across 35 specialized tables:
- TimeEntries - Access time entry records with duration, project association, and task details.
- Projects - Query project records including project details, client relationships, and billing information.
- Workspaces - Retrieve workspace information and configuration settings.
- Clients - Access client records with contact information and project relationships.
- Tasks - Query task records with project association and completion status.
- Tags - Access tag definitions for categorizing time entries and projects.
- User - Retrieve current user information and account settings.
- Organizations - Query organization records and membership data.
- WorkspaceUsers - Access workspace membership information and user roles.
- WorkspaceClients - Query client relationships within specific workspaces.
- WorkspaceTasks - Access task data scoped to specific workspaces.
- WorkspaceRates - Query billing rates and pricing information for workspaces.
- WorkspaceStatistics - Retrieve statistical data and metrics for workspace activity.
- WorkspaceProjectUsers - Access user assignments and permissions for workspace projects.
- WorkspaceProjectGroups - Query project grouping and organization within workspaces.
- WorkspaceTimeEntryConstraints - Access time entry validation rules and constraints.
- WorkspaceTimesheets - Query timesheet records and approval workflows.
- WorkspaceTimesheetSetups - Access timesheet configuration and setup information.
- OrganizationUsers - Query user membership and roles within organizations.
- OrganizationGroups - Access group definitions and membership within organizations.
- OrganizationWorkspaceUsers - Query user access across organization workspaces.
- TrackReminders - Access reminder settings and notification preferences.
- WebTimer - Query web timer data and browser-based time tracking.
- Preferences - Access user preferences and account settings.
- Location - Query location data and geographical information.
- Features - Access feature flags and capability information.
- Quota - Query usage limits and subscription information.
- SearchUsers - Access user search functionality and results.
- ReportsShared - Query shared report data and analytics.
- ProjectSummary - Access summarized project data and metrics.
- ProjectDetailSummary - Query detailed project summary information.
- InsightsDataTrendsProjects - Access project trend analysis and insights data.
- FilterProjectsStatus - Query project status filtering options.
- FilterTasksStatus - Access task status filtering capabilities.
Usage Examples
Query all time entries by workspace:
SELECT * FROM TimeEntries WHERE WorkspaceId = '123456'
Query all projects:
SELECT * FROM Projects
Query all workspaces:
SELECT * FROM Workspaces
Query all clients:
SELECT * FROM Clients
Query all time entries:
SELECT * FROM TimeEntries WHERE WorkspaceId = '123456'
Get active projects only:
SELECT * FROM Projects WHERE Active = 'true'
Query time entries within date range:
SELECT * FROM TimeEntries WHERE WorkspaceId = '123456' AND StartDate = '2024-01-01' AND EndDate = '2024-01-31'
Query projects with archived included:
SELECT * FROM Projects WHERE IncludeArchived = 'true'
Get projects modified since timestamp:
SELECT * FROM Projects WHERE Since = '1640995200'
Query tasks for a specific project:
SELECT * FROM Tasks WHERE ProjectId = '123456'
Get current user information:
SELECT * FROM User
Query workspace users:
SELECT * FROM WorkspaceUsers WHERE WorkspaceId = '123456'
Query time entries with metadata:
SELECT * FROM TimeEntries WHERE WorkspaceId = '123456' AND Meta = 'true'
Query time entries with sharing details:
SELECT * FROM TimeEntries WHERE WorkspaceId = '123456' AND IncludeSharing = 'true'
Get organization information:
SELECT * FROM Organizations
Query workspace statistics:
SELECT * FROM WorkspaceStatistics WHERE WorkspaceId = '123456'
Get project summary data:
SELECT * FROM ProjectSummary WHERE ProjectId = '123456'
Query time entry reminders:
SELECT * FROM TrackReminders
Get user preferences:
SELECT * FROM Preferences
Query workspace timesheets:
SELECT * FROM WorkspaceTimesheets WHERE WorkspaceId = '123456'
Get project insights data:
SELECT * FROM InsightsDataTrendsProjects WHERE ProjectId = '123456'
Query current time entries:
SELECT * FROM TimeEntries WHERE WorkspaceId = '123456' AND GetCurrentTimeEntries = 'true'
Get workspace project assignments:
SELECT * FROM WorkspaceProjectUsers WHERE WorkspaceId = '123456'
Query account quota information:
SELECT * FROM Quota
Get time entry constraints:
SELECT * FROM WorkspaceTimeEntryConstraints WHERE WorkspaceId = '123456'
Search for users:
SELECT * FROM SearchUsers WHERE SearchTerm = '[email protected]'
Query available features:
SELECT * FROM Features
Query all tags:
SELECT * FROM Tags WHERE WorkspaceId = '123456'
Search tags by name:
SELECT * FROM Tags WHERE WorkspaceId = '123456' AND Search = 'important'
Query workspace clients:
SELECT * FROM WorkspaceClients WHERE WorkspaceId = '123456'
Query active workspace clients:
SELECT * FROM WorkspaceClients WHERE WorkspaceId = '123456' AND Status = 'active'
Query workspace tasks:
SELECT * FROM WorkspaceTasks WHERE WorkspaceId = '123456'
Query active workspace tasks:
SELECT * FROM WorkspaceTasks WHERE WorkspaceId = '123456' AND Active = 'true'
Query workspace rates:
SELECT * FROM WorkspaceRates WHERE WorkspaceId = '123456'
Query workspace project groups:
SELECT * FROM WorkspaceProjectGroups WHERE WorkspaceId = '123456'
Query workspace timesheet setups:
SELECT * FROM WorkspaceTimesheetSetups WHERE WorkspaceId = '123456'
Query organization users:
SELECT * FROM OrganizationUsers WHERE OrganizationId = '123456'
Query organization groups:
SELECT * FROM OrganizationGroups WHERE OrganizationId = '123456'
Query organization workspace users:
SELECT * FROM OrganizationWorkspaceUsers WHERE OrganizationId = '123456'
Query web timer data:
SELECT * FROM WebTimer
Query location data:
SELECT * FROM Location
Query shared reports:
SELECT * FROM ReportsShared WHERE WorkspaceId = '123456'
Query project detail summary:
SELECT * FROM ProjectDetailSummary WHERE WorkspaceId = '123456'
Query project status filters:
SELECT * FROM FilterProjectsStatus WHERE WorkspaceId = '123456'
Query task status filters:
SELECT * FROM FilterTasksStatus WHERE WorkspaceId = '123456'
Connection Properties
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.
| Property | Description |
| APIKey | Your Toggl API Key. |
| AuthScheme | The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT |