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

BambooHR Directory API

Employee directory

BambooHR Directory API is one of 8 APIs that BambooHR publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Directory. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1.

1 operations 1 paths 1 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://api.bamboohr.com/api/gateway.php
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 2

BambooHR Directory API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope.

  • basicAuth — HTTP Basic auth. Use the API key as the username and any non-empty string as the password.
  • oauth2 — OAuth 2.0 authorization code flow (for multi-customer apps).

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.

Directory 1

Employee directory

GET
/employees/directory
Get the employee directory
getEmployeeDirectory → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Employee (11 properties). Each schema is shown below with its type and property counts.

Employee
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bamboohr-directory-api-openapi.yml Raw ↑

Other APIs BambooHR publishes across the network.

BambooHR REST API
BambooHR Webhooks
BambooHR Employees API
BambooHR Files API
BambooHR Meta API
BambooHR Reports API
BambooHR Time Off API