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 Team Members API

Company team members and their notes.

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

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

This API exposes 3 operations across 3 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.

3 operations 3 paths 6 schemas 3 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 Team Members 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 3

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

Team Members 3

Company team members and their notes.

GET
/team_members
List team members
listTeamMembers 2 params → 200401
GET
/team_members/{id}
Get a team member
getTeamMember 1 param → 200401404
GET
/team_members/{id}/notes
List a team member's notes
listTeamMemberNotes 3 params → 200401404

Schemas 6

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

TeamMemberList
object
3 properties
Pagination
object
Pagination metadata returned with list responses.
3 properties
GenericList
object
Generic list envelope used where the per-item schema is not fully published in CharlieHR's documentation.
3 properties
TeamMemberResponse
object
2 properties
TeamMember
object
A team member (employee) of the authenticated company. Field set reflects CharlieHR's documented team member object; additional fields may be returned.
11 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charliehr-team-members-api-openapi.yml Raw ↑

Other APIs CharlieHR publishes across the network.

CharlieHR Company API
CharlieHR Leave / Absences API
CharlieHR Leave Allowances API