Metadata-Version: 2.4
Name: bamboohr-api
Version: 0.1.1
Summary: Add your description here
Requires-Python: >=3.14
Description-Content-Type: text/markdown
Requires-Dist: httpx2>=2.5.0

# BambooHR SDK

This SDK targets BambooHR's single-company API authentication model.

## Authentication

For a single BambooHR customer integration you need:

- A BambooHR account
- The company domain (if your URL is `https://mycompany.bamboohr.com`, the domain is `mycompany`)
- A user API key

BambooHR uses HTTP Basic Auth for API key authentication:

- Username: API key
- Password: any non-empty string (commonly `x`)

## Python Usage

```python
from bamboohr.client import BambooHR

with BambooHR(domain="mycompany", api_key="YOUR_API_KEY") as client:
	directory = client.get("/employees/directory")
	print(directory)
```

The client base URL is built as:

`https://{domain}.bamboohr.com/api/v1`

## curl Example

```bash
curl -i -u "{API_KEY}:x" "https://{companyDomain}.bamboohr.com/api/v1/employees/directory"
```
