Class: TogglClient

Members

staticTogglClient.USER_AGENT

User agent string

authData

Result of authentication call

Methods

staticTogglClient.createUser(email, password, timezone, callback)

api/user.js, line 21

Create new user

Name	Type	Description
email	string	User e-mail address
password	string	User password
timezone	string	optional Timezone. UTC by default.
callback	function	Accepts arguments: (err, userData)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/users.md#sign-up-new-user

staticTogglClient.defaultClient(){TogglClient}

client.js, line 141

Return default API client

staticTogglClient.setDefaults(newDefaults)

client.js, line 159

Set default settings for client

Name	Type	Description
newDefaults	object

addProjectUser(projectId, userId, options, fields, callback)

api/project_users.js, line 20

Add user to project

Name	Type	Description
projectId	number | string	Project ID
userId	number | string	User ID
options	object	optional Project user options
fields	string[]	optional List of User fields to populate
callback	function	Accepts arguments: (err, projectUser)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/project_users.md#create-a-project-user

addProjectUsers(projectId, userIds, options, fields, callback)

api/project_users.js, line 73

Add several users to project

Name	Type	Description
projectId	number | string	Project ID
userIds	Array.<number> | Array.<string>	User IDs
options	object	optional Project user options
fields	string[]	optional List of User fields to populate
callback	function	Accepts arguments: (err, projectUsers)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/project_users.md#create-multiple-project-users-for-single-project

addTimeEntriesTags()

api/time_entries.js, line 15

Add time entries tags

See:

• TogglClient#updateTimeEntriesTags

authenticate(callback)

client.js, line 235

Make authentication call only if you use username & password

Name	Type	Description
callback	function	optional Accepts arguments: (err, userData)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/authentication.md

changeUserPassword(currentPassword, password, callback)

api/user.js, line 55

Change user password

Name	Type	Description
currentPassword	string	optional Current password
password	string	New password
callback	function	Accepts arguments: (err)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/users.md#update-user-data

createClient(data, callback)

api/clients.js, line 17

Create a client

Name	Type	Description
data	object	New client data
callback	function	Accepts arguments: (err, clientData)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/clients.md#create-a-client

createProject(data, callback)

api/projects.js, line 17

Create a project

Name	Type	Description
data	object	New project data
callback	function	Accepts arguments: (err, projectData)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#create-project

createTag(name, workspaceId, callback)

api/tags.js, line 18

Create tag

Name	Type	Description
name	string	Tag name
workspaceId	number | string	Workspace ID
callback	function	Accepts arguments: (err, tag)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/tags.md#create-tag

createTask(name, projectId, data, callback)

api/tasks.js, line 19

Create task

Name	Type	Description
name	string	Task name
projectId	number | string	ID of project for what task is created
data	object	Task options
callback	function	Accepts arguments: (err, task)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/tasks.md#create-a-task

createTimeEntry(data, callback)

api/time_entries.js, line 30

Create time entry

Name	Type	Description
data	object	Time entry data
callback	function	Accepts arguments: (err, timeEntry)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/time_entries.md#create-a-time-entry

deleteClient(clientId, callback)

api/clients.js, line 43

Delete client

Name	Type	Description
clientId	number | string	Client ID
callback	function	Accepts arguments: (err)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/clients.md#delete-a-client

deleteProject(projectId, callback)

api/projects.js, line 43

Delete project

Name	Type	Description
projectId	number | string	Project ID
callback	function	Accepts arguments: (err)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#delete-a-project

deleteProjects(projectIds, callback)

api/projects.js, line 62

Delete projects

Name	Type	Description
projectIds	Array.<number> | Array.<string>	Project IDs
callback	function	Accepts arguments: (err)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#delete-multiple-projects

deleteProjectUser(puID, callback)

api/project_users.js, line 90

Delete project user

Name	Type	Description
puID	number | string	Project user ID
callback	function	Accepts arguments: (err)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/project_users.md#delete-a-project-user

deleteProjectUsers(puIDs, callback)

api/project_users.js, line 109

Delete project users

Name	Type	Description
puIDs	Array.<number> | Array.<string>	Project user IDs
callback	function	Accepts arguments: (err)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/project_users.md#delete-multiple-project-users

deleteTag(tagId, callback)

api/tags.js, line 49

Delete tag

Name	Type	Description
tagId	number | string	Tag Id
callback	function	Accepts arguments: (err)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/tags.md#delete-a-tag

deleteTask(taskId, callback)

api/tasks.js, line 44

Delete task

Name	Type	Description
taskId	number | string	Task ID
callback	function	Accepts arguments: (err)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/tasks.md#delete-a-task

deleteTasks(taskIds, callback)

api/tasks.js, line 63

Delete several tasks

Name	Type	Description
taskIds	Array.<number> | Array.<string>	Task IDs
callback	function	Accepts arguments: (err)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/tasks.md#delete-multiple-tasks

deleteTimeEntry(teId, callback)

api/time_entries.js, line 58

Delete time entry

Name	Type	Description
teId	number | string	Time entry Id
callback	function	Accepts arguments: (err)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/time_entries.md#delete-a-time-entry

deleteWorkspaceUser(wuId, callback)

api/workspace_users.js, line 17

Delete workspace user

Name	Type	Description
wuId	number | string	Workspace user Id
callback	function	Accepts arguments: (err)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/workspace_users.md#delete-workspace-user

destroy()

client.js, line 314

Call when client is no longer needed

detailedReport(opts, callback)

api/reports.js, line 56

Get detailed report

Name	Type	Description
opts	object	Request options
callback	function	Accepts arguments: (err, report)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/reports/detailed.md

getClientData(clientId, callback)

api/clients.js, line 62

Get client details

Name	Type	Description
clientId	number | string	Client ID
callback	function	Accepts arguments: (err, clientData)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/clients.md#get-client-details

getClientProjects(clientId, active, callback)

api/clients.js, line 78

Get client projects

Name	Type	Description
clientId	number | string	Client ID
active	string | boolean	Filter projects: active (true), archived (false), both
callback	function	Accepts arguments: (err, projects)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/clients.md#get-client-projects

getClients(callback)

api/clients.js, line 100

Get list of clients

Name	Type	Description
callback	function	Accepts arguments: (err, clients)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/clients.md#get-clients-visible-to-user

getCurrentTimeEntry(callback)

api/time_entries.js, line 130

Get current running time entry

Name	Type	Description
callback	function	Accepts arguments: (err, timeEntry)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/time_entries.md#get-running-time-entry

getProjectData(projectId, callback)

api/projects.js, line 82

Get project data

Name	Type	Description
projectId	number | string	Project ID
callback	function	Accepts arguments: (err, projectData)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#get-project-data

getProjectTasks(projectId, callback)

api/projects.js, line 97

Get project tasks list

Name	Type	Description
projectId	number | string	Project ID
callback	function	Accepts arguments: (err, tasks)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#get-project-tasks

getProjectUsers(projectId, callback)

api/projects.js, line 112

Get project users list

Name	Type	Description
projectId	number | string	Project ID
callback	function	Accepts arguments: (err, users)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#get-project-users

getTaskData(taskId, callback)

api/tasks.js, line 78

Get task details

Name	Type	Description
taskId	number | string	Task ID
callback	function	Accepts arguments: (err, task)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/tasks.md#get-task-details

getTimeEntries(startDate, endDate, callback)

api/time_entries.js, line 93

Get time entries started in a specific time range

Name	Type	Description
startDate	string | number | Date | moment	optional Date range start
endDate	string | number | Date | moment	optional Date range end
callback	function	Accepts arguments(err, timeEntries)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/time_entries.md#get-time-entries-started-in-a-specific-time-range

getTimeEntryData(teId, callback)

api/time_entries.js, line 77

Get time entry details

Name	Type	Description
teId	number | string	Time entry Id
callback	function	Accepts arguments: (err, timeEntry)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/time_entries.md#get-time-entry-details

getUserData(options, callback)

api/user.js, line 90

Get user data

Name	Type	Description
options	object	Request options
callback	function	Accepts arguments: (err, userData)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/users.md#get-current-user-data

getWorkspaceClients(wId, callback)

api/workspaces.js, line 17

Get workspace users

Name	Type	Description
wId	number | string	Workspace Id
callback	function	Accepts arguments: (err, clients)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/workspaces.md#get-workspace-clients

getWorkspaceData(wId, callback)

api/workspaces.js, line 32

Get workspace data

Name	Type	Description
wId	number | string	Workspace Id
callback	function	Accepts arguments: (err, workspace)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/workspaces.md#get-single-workspace

getWorkspaceProjects(wId, options, callback)

api/workspaces.js, line 48

Get workspace projects

Name	Type	Description
wId	number | string	Workspace Id
options	object	optional Request options
callback	function	Accepts arguments: (err, projects)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/workspaces.md#get-workspace-projects

getWorkspaces(callback)

api/workspaces.js, line 150

Get data about all workspaces

Name	Type	Description
callback	function	Accepts arguments: (err, workspaces)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/workspaces.md#get-workspaces

getWorkspaceTags(wId, callback)

api/workspaces.js, line 76

Get workspace tags

Name	Type	Description
wId	number | string	Workspace Id
callback	function	Accepts arguments: (err, tags)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/workspaces.md#get-workspace-tags

getWorkspaceTasks(wId, options, callback)

api/workspaces.js, line 92

Get workspace tasks

Name	Type	Description
wId	number | string	Workspace Id
options	object	optional Request options
callback	function	Accepts arguments: (err, tasks)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/workspaces.md#get-workspace-tasks

getWorkspaceUsers(wId, actualUsers, callback)

api/workspaces.js, line 122

Get workspace users

Name	Type	Default	Description
wId	number | string		Workspace Id
actualUsers	boolean	true	optional Return actual users or 'workspace user' objects
callback	function		Accepts arguments: (err, users)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/workspaces.md#get-workspace-users
• @see https://github.com/toggl/toggl_api_docs/blob/master/chapters/workspace_users.md#get-workspace-users

inviteUsers(workspaceId, emails, callback)

api/workspace_users.js, line 37

Invite users to workspace

Name	Type	Description
workspaceId	number | string	Workspace Id
emails	string[]	E-mail addresses
callback	function	Accepts arguments: (err, users, notifications)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/workspace_users.md#invite-users-to-workspace

removeTimeEntriesTags()

api/time_entries.js, line 143

Remove time entries tags

See:

• TogglClient#updateTimeEntriesTags

resetApiToken(callback)

api/user.js, line 108

Reset API token

Name	Type	Description
callback	function	Accepts arguments: (err)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/users.md#reset-api-token

startTimeEntry(data, callback)

api/time_entries.js, line 158

Create time entry and start it

Name	Type	Description
data	object	Time entry data
callback	function	Accepts arguments: (err, timeEntry)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/time_entries.md#start-a-time-entry

stopTimeEntry(teId, callback)

api/time_entries.js, line 182

Stop time entry

Name	Type	Description
teId	number | string	Time entry Id
callback	function	Accepts arguments: (err, timeEntry)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/time_entries.md#stop-a-time-entry

summaryReport(opts, callback)

api/reports.js, line 75

Get summary report

Name	Type	Description
opts	object	Request options
callback	function	Accepts arguments: (err, report)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/reports/summary.md

updateClient(clientId, data, callback)

api/clients.js, line 116

Update client details

Name	Type	Description
clientId	number | string	Client ID
data	object	Client data
callback	function	Accepts arguments: (err, clientData)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/clients.md#update-a-client

updateProject(projectId, data, callback)

api/projects.js, line 128

Update project details

Name	Type	Description
projectId	number | string	project ID
data	object	Project data
callback	function	Accepts arguments: (err, projectData)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#update-project-data

updateProjectUser(puID, options, fields, callback)

api/project_users.js, line 126

Update project user data

Name	Type	Description
puID	number | string	Project user ID
options	object	Project user options
fields	string[]	optional List of User fields to populate
callback	function	Accepts arguments: (err, projectUser)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/project_users.md#update-a-project-user

updateProjectUsers(puIDs, options, fields, callback)

api/project_users.js, line 159

Update data for several project users

Name	Type	Description
puIDs	Array.<number> | Array.<string>	Project user IDs
options	object	Project user options
fields	string[]	optional List of User fields to populate
callback	function	Accepts arguments: (err, projectUsers)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/project_users.md#mass-update-for-project-users

updateTagName(tagId, name, callback)

api/tags.js, line 69

Update tag name

Name	Type	Description
tagId	number | string	Tag Id
name	string	New tag name
callback	function	Accepts arguments: (err, tag)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/tags.md#update-a-tag

updateTask(taskId, data, fields, callback)

api/tasks.js, line 95

Update task

Name	Type	Description
taskId	number | string	Task ID
data	object	Update data
fields	string[]	optional Fields to include into output
callback	function	Accepts arguments: (err, task)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/tasks.md#update-a-task

updateTasks(taskIds, data, fields, callback)

api/tasks.js, line 128

Update tasks

Name	Type	Description
taskIds	Array.<number> | Array.<string>	Task IDs
data	object	Update data
fields	string[]	optional Fields to include into output
callback	function	Accepts arguments: (err, task)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/tasks.md#update-multiple-tasks

updateTimeEntriesTags(teIds, tags, action, callback)

api/time_entries.js, line 226

Update time entries tags

Name	Type	Description
teIds	Array.<number> | Array.<string>	Time entries Ids
tags	string[]	Tags to add/remove
action	string	'add' or 'remove'
callback	function	Accepts arguments: (err, timeEntries)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/time_entries.md#bulk-update-time-entries-tags

updateTimeEntry(teId, data, callback)

api/time_entries.js, line 202

Update time entry

Name	Type	Description
teId	number | string	Time entry Id
data	object	Update data
callback	function	Accepts arguments: (err, timeEntry)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/time_entries.md#update-a-time-entry

updateUserData(data, callback)

api/user.js, line 142

Update user data

Name	Type	Description
data	object	Update data
callback	function

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/users.md#update-user-data

updateWorkspace(wId, data, callback)

api/workspaces.js, line 166

Update workspace data

Name	Type	Description
wId	number | string	Workspace Id
data	object	Update data
callback	function	Accepts arguments: (err, workspace)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/workspaces.md#update-workspace

updateWorkspaceUser(wuId, options, callback)

api/workspace_users.js, line 69

Update workspace user

Name	Type	Description
wuId	number | string	Workspace user Id
options	object	Update data
callback	function	Accepts arguments: (err, workspaceUser)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/chapters/workspace_users.md#update-workspace-user

weeklyReport(opts, callback)

api/reports.js, line 98

Get weekly report

Name	Type	Description
opts	object	Request options
callback	function	Accepts arguments: (err, report)

See:

• https://github.com/toggl/toggl_api_docs/blob/master/reports/weekly.md