https://github.com/genert/pipedrive-api
Pipedrive API client written in Go
https://github.com/genert/pipedrive-api
api golang pipedrive
Last synced: 4 months ago
JSON representation
Pipedrive API client written in Go
- Host: GitHub
- URL: https://github.com/genert/pipedrive-api
- Owner: genert
- License: mit
- Created: 2017-10-12T21:17:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-16T18:45:07.000Z (over 6 years ago)
- Last Synced: 2025-08-14T02:21:25.318Z (10 months ago)
- Topics: api, golang, pipedrive
- Language: Go
- Homepage:
- Size: 144 KB
- Stars: 6
- Watchers: 0
- Forks: 22
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Golang Pipedrive client
[](https://travis-ci.org/Genert/go-pipedrive)
Requires Go version 1.7 or greater.
# Supported resources
- [x] Activities
- [x] ActivityFields
- [x] ActivityTypes
- [x] Authorizations
- [x] Currencies
- [x] Deals
- [x] DealFields
- [x] Files
- [x] Filters
- [x] Goals
- [x] Notes
- [x] NoteFields
- [x] Organizations
- [x] OrganizationFields
- [x] Persons
- [x] PersonFields
- [x] Pipelines
- [x] Products
- [x] ProductFields
- [x] Recents
- [x] SearchResults
- [x] Stages
- [x] Users
- [x] User connections
- [x] User settings
- [x] Webhooks
## Installation
```go
go get -v github.com/genert/pipedrive-api/pipedrive
```
## Usage
```go
import "github.com/genert/pipedrive-api/pipedrive"
```
Construct a new Pipedrive client, then use the various services on the client to
access different parts of the API. For example:
```go
const apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
client := pipedrive.New(&pipedrive.Config{
APIKey: apiKey,
})
// Return list of all fields for note
noteFields, _, _ := client.NoteFields.List()
// You can then access data like this:
fmt.Println("Success = ", noteFields.Success)
fmt.Println("First note field: ", noteFields.Data[0].Name)
```
### Integration Tests ###
You can run integration tests from the `test` directory. See the integration tests [README](test/README.md).
## Contributions & Issues
Contributions are welcome. Please clearly explain the purpose of the PR and follow the current style.
Issues can be resolved quickest if they are descriptive and include both a reduced test case and a set of steps to reproduce.
## License
This library is distributed under the MIT license found in the [LICENSE](./LICENSE)
file.