# Customer API

Version: 1.0.360658

## Servers

```
https://api.bright.hr
```

## Security

### Bearer

Bearer token authentication

Type: http
Scheme: Bearer

### OAuth2

Type: oauth2

## Download OpenAPI description

[Customer API](https://docs.bright.hr/_bundle/api/customer-api-v1.yaml)

## Employees

### List Employees

 - [POST /employees/v1/query](https://docs.bright.hr/api/customer-api-v1/employees/post_employees_v1_query.md): List all employees in your organisation.

### Set Employee External Reference

 - [PUT /employees/v1/{employeeId}/external-reference](https://docs.bright.hr/api/customer-api-v1/employees/put_employees_v1_employeeid_guid_external_reference.md): Set the external reference for an employee.

## Blip

### List Blip clockings

 - [POST /blip/v1/clockings/query](https://docs.bright.hr/api/customer-api-v1/blip/post_blip_v1_clockings_query.md): List clockings for all employees in your organisation.

## Absences

### List Absences

 - [POST /absences/v1/query](https://docs.bright.hr/api/customer-api-v1/absences/post_absences_v1_query.md): List approved absences for employees in your organisation.

This includes sickness, time-off-in-lieu (TOIL), annual leave and "other" absences.
Lateness is not included.

The $type field denotes the type of absence:
- Holiday: used for annual leave, public holidays, and mandatory leave.
- Sickness: used for absences due to sickness or illness.
- Toil: used for time-off-in-lieu (TOIL)
- Other: used for any other type of absence (except Lateness) that doesn't fit into the above categories.

