Skip to content
hscli

hscli api

hscli api is the escape hatch. When a high-level command doesn't exist yet, call any Help Scout API endpoint directly. Requests are locked to the Help Scout host, so a mistyped or hallucinated URL can't send your token anywhere else.

Usage

Section titled “Usage”
hscli api <METHOD> <path> [--body <json>] [--content-type <type>] [flags]
zsh — hscli
# GET — list mailbox names
hscli api GET /v2/mailboxes --jq '.[] | .name'


# POST — add a tag to a conversation
hscli api POST /v2/conversations/4831/tags --body '{"tags":["vip"]}'


# PUT / PATCH / DELETE all work the same way
hscli api DELETE /v2/conversations/4831/tags/vip

Notes

Section titled “Notes”
  • The path is relative to the Help Scout API host; you cannot point it elsewhere.
  • Send a request body with --body (inline JSON or @file.json); override the type with --content-type if needed.
  • All global flags apply, including --output, --jq, and --fields.
  • Authentication uses the same token as every other command — see Authentication.