API Reference
Become a partner

Fetch daily attendance breakdown

post
https://api.hibob.com/v1/attendance/daily-breakdown/search

This endpoint allows you to retrieve daily attendance breakdown data for employees. Each item in the response represents one day's attendance data for an employee, including hours worked, breaks, overtime, and other daily metrics. Please note that this endpoint requires body parameters, which is why it utilizes a POST request for a read operation.

Before using this endpoint:

  • Explore the Attendance API for more details on usage, rate limits, permissions, and more.
  • You must provide both `date` and `employeeId` filters in the request.
  • Only fields mentioned in the `fields` parameter are returned in the response.
  • Pagination: Use `limit` and `cursor` parameters to paginate through results. The `cursor` value for the next page is returned in `response_metadata.next_cursor`. To learn more, see Pagination in Bob's API.

Testing notes:

  • Use the testing widget's Try It! option to test this endpoint.
  • Use the Examples > Request Example option to see how to initiate body parameters.
Body Params
fields
array of strings
required
Defaults to /dailyBreakdown/employeeId,/dailyBreakdown/date,/dailyBreakdown/hoursWorked,/dailyBreakdown/payableHours

List of field IDs to include in the response. Standard fields are listed above. Custom fields following the pattern /dailyBreakdown/field_<number> are also supported. Required: The array must include both /dailyBreakdown/employeeId and /dailyBreakdown/date.

fields*
filters
array of objects
required
length between 3 and 3
Defaults to [object Object],[object Object],[object Object]

List of filters to apply. You must provide exactly three filters: 1. One date filter (fieldId: /dailyBreakdown/date, operator: from) with exactly 1 start date 2. One date filter (fieldId: /dailyBreakdown/date, operator: to) with exactly 1 end date 3. One employeeId filter (fieldId: /dailyBreakdown/employeeId, operator: equals) with one or more employee IDs

filters*
string
enum
required

Field ID for the filter. Use /dailyBreakdown/date for date filter or /dailyBreakdown/employeeId for employee ID filter.

Allowed:
string
enum
required

Filter operator. Use from or to for date filters, equals for employee ID filter.

Allowed:
values
array of strings
required

Filter values. For date filter: provide exactly 1 date in ISO format (YYYY-MM-DD). For employeeId filter: provide one or more employee IDs.

values*
string
enum
required

Field ID for the filter. Use /dailyBreakdown/date for date filter or /dailyBreakdown/employeeId for employee ID filter.

Allowed:
string
enum
required

Filter operator. Use from or to for date filters, equals for employee ID filter.

Allowed:
values
array of strings
required

Filter values. For date filter: provide exactly 1 date in ISO format (YYYY-MM-DD). For employeeId filter: provide one or more employee IDs.

values*
string
enum
required

Field ID for the filter. Use /dailyBreakdown/date for date filter or /dailyBreakdown/employeeId for employee ID filter.

Allowed:
string
enum
required

Filter operator. Use from or to for date filters, equals for employee ID filter.

Allowed:
values
array of strings
required

Filter values. For date filter: provide exactly 1 date in ISO format (YYYY-MM-DD). For employeeId filter: provide one or more employee IDs.

values*
integer
1 to 1000
Defaults to 100

Maximum number of items to return per page. Defaults to 100.

string

Opaque cursor for pagination. Use the value from response_metadata.next_cursor in the previous response to get the next page. Do not provide in the first request.

boolean

This property is not currently supported for this endpoint. Whether to include human-readable formatted values alongside raw values in the response.

Responses

Updated 3 months ago

Language
Credentials
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago