scusi / pipedrive-api

Pipedrive API client written in Go

Golang Pipedrive client

Requires Go version 1.7 or greater.

Supported resources

• Activities
• ActivityFields
• ActivityTypes
• Authorizations
• Currencies
• Deals
• DealFields
• Files
• Filters
• Goals
• Notes
• NoteFields
• Organizations
• OrganizationFields
• Persons
• PersonFields
• Pipelines
• Products
• ProductFields
• Recents
• SearchResults
• Stages
• Users
• User connections
• User settings
• Webhooks

Installation

go get -v github.com/scusi/pipedrive-api/pipedrive

Usage

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:

    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.

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 file.