Skip to content
This repository has been archived by the owner on Oct 5, 2023. It is now read-only.

Latest commit

 

History

History
40 lines (25 loc) · 624 Bytes

README.markdown

File metadata and controls

40 lines (25 loc) · 624 Bytes
Raw

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)