Help Scout Customers API
The Customers API from Help Scout — 2 operation(s) for customers.
Help Scout Customers 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 Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 4 operations across 2 paths, and defines 1 schema. 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Help Scout Customers 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 4
Across 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Customer (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Help Scout 12
Other APIs Help Scout publishes across the network.