Skip to main content
GET
Get Team Attendance

Get Team Attendance

Returns the attendance matrix for a team centred on a given date. Includes per-member day-of-week attendance preferences (office, home, abroad, not working), aggregate statistics, and any bookings overlapping the requested week.

Authentication

Requires a valid customer bearer token. The customer must be a member or administrator of the specified team.

Path Parameters

number
required
Numeric identifier of the team. Returned as Id from GET /api/public/teams/my.

Query Parameters

string
required
ISO 8601 UTC datetime specifying the week to retrieve. The API returns the full week containing this date.
string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation.

Response

boolean
Whether the authenticated customer is an administrator of this team. Used by the portal to show or hide the attendance editing UI.
TeamAttendanceDetails
required
The attendance data object.

Attendance Details

number
Numeric identifier of the team.
string
Display name of the team.
number
Average booked minutes per week across all members.
number
Average number of members with bookings per day.
number
Average number of members checked in per day.
number
Average check-in days per week.

Attendance.Coworkers[]

number
Numeric identifier of the member.
string
Display name of the member.
number
Member type code.
string | undefined
Company name associated with the member, if any.
eCoworkerAttendance
Monday attendance status: 1 = Office, 2 = Home, 3 = Abroad, 4 = Not Working, 5 = Undefined.
eCoworkerAttendance
Tuesday attendance status (same values as Monday).
eCoworkerAttendance
Wednesday attendance status.
eCoworkerAttendance
Thursday attendance status.
eCoworkerAttendance
Friday attendance status.
eCoworkerAttendance
Saturday attendance status.
eCoworkerAttendance
Sunday attendance status.

Attendance.Days[]

string
ISO 8601 date for this day.
AttendanceBooking[]
Bookings on this day.
number
Booking identifier.
string
Booking start time.
string
Booking end time.
number
Identifier of the booked resource.
string
Name of the booked resource.
number | undefined
Customer who owns the booking, if applicable.

Examples

Fetch attendance for a week

TypeScript Integration

Usage in Portal

Error Responses

error
The customer is not authenticated or the session has expired.
error
Team with the specified ID does not exist.