List Time Tracking Kiosks
Changed onReturns a paginated list of time tracking kiosks. Deleted kiosks are never returned. Supports an OData-style filter, an orderBy sort expression, and select sparse fieldsets. Results are sorted by name ascending when orderBy is omitted; name ordering is case-insensitive. Pagination is page-based via page and pageSize (defaults: page 1, pageSize 20, max 100).
OAuth Scopes: time_tracking:kiosks
Request
- Base URLhttps://companySubDomain.bamboohr.com
- Auth
- HTTP basic
- or OAuth 2Authorization code/authorize.phpToken URL/token.phpScopestime_tracking:kiosks
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
OData v4 filter expression. Filterable fields: name, lastUsed, createdAt, updatedAt. Example: name eq 'Front Desk Kiosk'.
Sort expression like name asc, createdAt desc. Allowed fields: name, lastUsed, createdAt, updatedAt. Defaults to name asc.
Comma-separated list of properties to return (sparse fieldsets).
The page to retrieve. Defaults to 1.
The number of kiosks per page. Defaults to 20, minimum 10, maximum 100.
Response
A paginated list of kiosks.
Example response
{
"meta": {
"page": 2,
"pageSize": 20,
"totalPages": 4,
"totalItems": 68
},
"data": [
{
"id": "a3f1c2d4-5b6e-4f70-8a91-2c3d4e5f6a7b",
"name": "Front Desk Kiosk",
"lastUsed": "2026-07-29T18:52:50Z",
"createdAt": "2026-01-29T18:52:50Z",
"updatedAt": "2026-02-09T17:56:06Z"
}
]
}Changes
- info
endpoint added
- info