HelpScout API gem
Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.markdown

Helpscout Developers API gem

This gem is in beta.

Usage

  1. Follow the instructions at Help Scout's Developers site to generate an API key.

  2. Initialize your HelpScout client

helpscout = HelpScout::Client.new(HELPSCOUT_API_KEY)

Fetching Users

users = helpscout.users

Fetching Mailboxes

mailboxes = helpscout.mailboxes

Fetching Customers

customers = helpscout.customers

Fetching Conversations

To fetch active conversations:

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