CharlieHR Company API
Company record, offices, and teams.
CharlieHR Company API is one of 4 APIs that CharlieHR publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Company. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 5 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://charliehr.com/api/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
CharlieHR Company 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.
oauth2— OAuth 2.0. A Client ID and Client Secret issued in the CharlieHR app are exchanged for an access token, which is sent in the Authorization header of each reque…
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.
Company record, offices, and teams.
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Error (3 properties), GenericList (3 properties), Pagination (3 properties), Company (3 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 CharlieHR 3
Other APIs CharlieHR publishes across the network.