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

CharlieHR Leave Allowances API

Leave allowance balances.

CharlieHR Leave Allowances API is one of 4 APIs that CharlieHR publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Leave Allowances. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 5 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.

2 operations 2 paths 5 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://charliehr.com/api/v1
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

CharlieHR Leave Allowances 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 2

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

Leave Allowances 2

Leave allowance balances.

GET
/team_members/{id}/leave_allowance
Get a team member's leave allowance
getTeamMemberLeaveAllowance 1 param → 200401404
GET
/leave_allowances
List leave allowances
listLeaveAllowances 2 params → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are LeaveAllowance (6 properties), Error (3 properties), LeaveAllowanceList (3 properties), Pagination (3 properties). Each schema is shown below with its type and property counts.

LeaveAllowance
object
A team member's current leave allowance.
6 properties
LeaveAllowanceResponse
object
2 properties
Pagination
object
Pagination metadata returned with list responses.
3 properties
LeaveAllowanceList
object
3 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charliehr-leave-allowances-api-openapi.yml Raw ↑

Other APIs CharlieHR publishes across the network.

CharlieHR Company API
CharlieHR Leave / Absences API
CharlieHR Team Members API