https://github.com/hramos/helpscout

HelpScout API gem
https://github.com/hramos/helpscout

helpscout ruby

Last synced: 4 months ago
JSON representation

HelpScout API gem

• Host: GitHub
• URL: https://github.com/hramos/helpscout
• Owner: hramos
• License: mit
• Created: 2012-08-01T04:13:40.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2022-03-17T00:14:02.000Z (almost 4 years ago)
• Last Synced: 2025-10-07T20:40:50.919Z (5 months ago)
• Topics: helpscout, ruby
• Language: Ruby
• Size: 66.4 KB
• Stars: 37
• Watchers: 6
• Forks: 41
• Open Issues: 4
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE

Awesome Lists containing this project

README

          
# Helpscout Developers API gem

This gem is in beta.

## Usage

1. Follow the instructions at [Help Scout's Developers site](http://developer.helpscout.net/) to generate an API key.

2. Initialize your HelpScout client

```ruby

helpscout = HelpScout::Client.new(HELPSCOUT_API_KEY)

```

#### Fetching Users

```ruby

users = helpscout.users

```

#### Fetching Mailboxes

```ruby

mailboxes = helpscout.mailboxes

```

#### Fetching Customers

```ruby

customers = helpscout.customers

```

#### Fetching Conversations

To fetch active conversations:

```ruby

conversations = helpscout.conversations(mailboxId, "active", nil)

```