Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Help Scout Users API

The Users API from Help Scout — 1 operation(s) for users.

Help Scout Users API is one of 25 APIs that Help Scout publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://api.helpscout.net/v2.

1 operations 1 paths 0 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Server
https://api.helpscout.net/v2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Help Scout Users API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow. By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Users 1
GET
/users
List users
listUsers → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helpscout-users-api-openapi.yml Raw ↑

Other APIs Help Scout publishes across the network.

Help Scout Threads API
Help Scout Customers API
Help Scout Mailboxes API
Help Scout Teams API
Help Scout Tags API
Help Scout Workflows API
Help Scout Custom Fields API
Help Scout Attachments API
Help Scout Ratings API
Help Scout Reports API
Help Scout Webhooks API
Help Scout Docs API