https://github.com/go-api-libs/toggl
Go library for the toggl. The Toggl API allows developers to interact with Toggl's time tracking service programmatically. It provides endpoints for managing time entries, projects, clients, tags, and user information. With this API, you can automate time tracking, generate detailed reports, and integrate Toggl with other tools and services.
https://github.com/go-api-libs/toggl
api api-client api-library automation go golang integration openapi openapi3 productivity project-management time-management time-management-tools time-tracking toggl toggl-api
Last synced: 3 months ago
JSON representation
Go library for the toggl. The Toggl API allows developers to interact with Toggl's time tracking service programmatically. It provides endpoints for managing time entries, projects, clients, tags, and user information. With this API, you can automate time tracking, generate detailed reports, and integrate Toggl with other tools and services.
- Host: GitHub
- URL: https://github.com/go-api-libs/toggl
- Owner: go-api-libs
- License: mit
- Created: 2024-12-09T20:36:25.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-12-20T22:19:16.000Z (5 months ago)
- Last Synced: 2025-01-14T02:35:58.224Z (4 months ago)
- Topics: api, api-client, api-library, automation, go, golang, integration, openapi, openapi3, productivity, project-management, time-management, time-management-tools, time-tracking, toggl, toggl-api
- Language: Go
- Homepage:
- Size: 2.2 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Toggl API
[](https://pkg.go.dev/github.com/go-api-libs/toggl/pkg/toggl)
[](https://engineering.toggl.com/docs/)
[](/api/openapi.json)
[](https://goreportcard.com/report/github.com/go-api-libs/toggl)
[](./LICENSE)
The Toggl API allows developers to interact with Toggl's time tracking service programmatically. It provides endpoints for managing time entries, projects, clients, tags, and user information. With this API, you can automate time tracking, generate detailed reports, and integrate Toggl with other tools and services.
## Installation
To install the library, use the following command:
```shell
go get github.com/go-api-libs/toggl/pkg/toggl
```
## Usage
### Example 1: Return Current User
```go
package main
import (
"context"
"os"
"github.com/go-api-libs/toggl/pkg/toggl"
)
func main() {
c, err := toggl.NewClient("myUsername", os.Getenv("TOGGL_PASSWORD"))
if err != nil {
panic(err)
}
ctx := context.Background()
userWithRelated, err := c.GetMe(ctx, &toggl.GetMeParams{WithRelatedData: true})
if err != nil {
panic(err)
}
// Use userWithRelated object
}
```
### Example 2: Create a time entry
```go
package main
import (
"context"
"os"
"github.com/go-api-libs/toggl/pkg/toggl"
)
func main() {
c, err := toggl.NewClient("myUsername", os.Getenv("TOGGL_PASSWORD"))
if err != nil {
panic(err)
}
ctx := context.Background()
timeEntry, err := c.CreateTimeEntry(ctx, 2230580, toggl.NewTimeEntry{
CreatedWith: "github.com/go-api-libs/toggl",
Start: mustParseTime("2024-12-15T21:17:59.593648+01:00"),
WorkspaceID: 2230580,
})
if err != nil {
panic(err)
}
// Use timeEntry object
}
```
### Example 3: Get current time entry
```go
package main
import (
"context"
"os"
"github.com/go-api-libs/toggl/pkg/toggl"
)
func main() {
c, err := toggl.NewClient("myUsername", os.Getenv("TOGGL_PASSWORD"))
if err != nil {
panic(err)
}
ctx := context.Background()
timeEntry, err := c.GetCurrentTimeEntry(ctx)
if err != nil {
panic(err)
}
// Use timeEntry object
}
```
### Example 4: Stop an existing time entry
```go
package main
import (
"context"
"os"
"github.com/go-api-libs/toggl/pkg/toggl"
)
func main() {
c, err := toggl.NewClient("myUsername", os.Getenv("TOGGL_PASSWORD"))
if err != nil {
panic(err)
}
ctx := context.Background()
timeEntry, err := c.StopTimeEntry(ctx, 2230580, 3730303299)
if err != nil {
panic(err)
}
// Use timeEntry object
}
```
### Example 5: List time entries
```go
package main
import (
"context"
"os"
"github.com/go-api-libs/toggl/pkg/toggl"
)
func main() {
c, err := toggl.NewClient("myUsername", os.Getenv("TOGGL_PASSWORD"))
if err != nil {
panic(err)
}
ctx := context.Background()
timeEntries, err := c.ListTimeEntries(ctx, &toggl.ListTimeEntriesParams{
Before: mustParseTime("2024-12-16T03:25:20+01:00"),
EndDate: mustParseTime("2024-12-16T03:25:20+01:00"),
IncludeSharing: true,
Meta: true,
Since: 1734304527,
StartDate: mustParseTime("2024-12-16T03:25:20+01:00"),
})
if err != nil {
panic(err)
}
// Use timeEntries slice
}
```
### Example 6: Create a new organization
```go
package main
import (
"context"
"os"
"github.com/go-api-libs/toggl/pkg/toggl"
)
func main() {
c, err := toggl.NewClient("myUsername", os.Getenv("TOGGL_PASSWORD"))
if err != nil {
panic(err)
}
ctx := context.Background()
simpleOrganization, err := c.CreateOrganization(ctx, toggl.NewOrganization{
Name: "Your Organization",
WorkspaceName: "Your Workspace",
})
if err != nil {
panic(err)
}
// Use simpleOrganization object
}
```
### Example 7: List my organizations
```go
package main
import (
"context"
"os"
"github.com/go-api-libs/toggl/pkg/toggl"
)
func main() {
c, err := toggl.NewClient("myUsername", os.Getenv("TOGGL_PASSWORD"))
if err != nil {
panic(err)
}
ctx := context.Background()
organizations, err := c.ListOrganizations(ctx)
if err != nil {
panic(err)
}
// Use organizations slice
}
```
### Example 8: Get organization data
```go
package main
import (
"context"
"os"
"github.com/go-api-libs/toggl/pkg/toggl"
)
func main() {
c, err := toggl.NewClient("myUsername", os.Getenv("TOGGL_PASSWORD"))
if err != nil {
panic(err)
}
ctx := context.Background()
organization, err := c.GetOrganization(ctx, 9011051)
if err != nil {
panic(err)
}
// Use organization object
}
```
## Additional Information
- [**Go Reference**](https://pkg.go.dev/github.com/go-api-libs/toggl/pkg/toggl): The Go reference documentation for the client package.
- [**Official Documentation**](https://engineering.toggl.com/docs/): The official API documentation.
- [**OpenAPI Specification**](./api/openapi.json): The OpenAPI 3.1.0 specification.
- [**Go Report Card**](https://goreportcard.com/report/github.com/go-api-libs/toggl): Check the code quality report.
## Contributing
If you have any contributions to make, please submit a pull request or open an issue on the [GitHub repository](https://github.com/go-api-libs/toggl).
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.