Home/Attendance/Data Structures

Attendance Data Structures

Field definitions for key objects returned by Attendance APIs.

ID Format

Resources use prefixed public IDs (for example deal_..., inv_..., form_..., ak_...).

Punch object

Object representing a clock-in/clock-out punch.

Fields

Name	Type	Required	Description
id	string	Required	Punch ID
object	string	Required	Object type (`attendance.punch`)
organization_id	string	Required	Organization ID
user_id	string	Required	User ID
type	"clock_in" \| "clock_out"	Required	Punch type
punched_at	string	Required	Punched at (ISO 8601)
note	string \| null	Optional	Note
created_at	string	Required	Created at (ISO 8601)

{
  "id": "punch_01JQ3KXYZ",
  "object": "attendance.punch",
  "organization_id": "org_01HZXYZ",
  "user_id": "usr_01HZABC",
  "type": "clock_in",
  "punched_at": "2026-02-22T09:00:00Z",
  "note": null,
  "created_at": "2026-02-22T09:00:00Z"
}

Correction object

Object representing an attendance correction request.

Fields

Name	Type	Required	Description
id	string	Required	Correction ID
object	string	Required	Object type (`attendance.correction`)
organization_id	string	Required	Organization ID
user_id	string	Required	Requester user ID
date	string	Required	Target date (YYYY-MM-DD)
reason	string	Required	Reason
status	"pending" \| "approved" \| "rejected"	Required	Status
approved_by	string \| null	Optional	Approver ID
created_at	string	Required	Created at (ISO 8601)
updated_at	string	Required	Updated at (ISO 8601)

{
  "id": "corr_01JQ3KDEF",
  "object": "attendance.correction",
  "organization_id": "org_01HZXYZ",
  "user_id": "usr_01HZABC",
  "date": "2026-02-21",
  "reason": "Forgot to clock out",
  "status": "pending",
  "approved_by": null,
  "created_at": "2026-02-22T10:00:00Z",
  "updated_at": "2026-02-22T10:00:00Z"
}

LeaveRequest object

Object representing a leave request.

Fields

Name	Type	Required	Description
id	string	Required	Leave request ID
object	string	Required	Object type (`attendance.leave_request`)
organization_id	string	Required	Organization ID
user_id	string	Required	Requester user ID
leave_type	string	Required	Leave type
start_date	string	Required	Start date
end_date	string	Required	End date
reason	string \| null	Optional	Reason
status	"pending" \| "approved" \| "rejected"	Required	Status
created_at	string	Required	Created at (ISO 8601)
updated_at	string	Required	Updated at (ISO 8601)

{
  "id": "leave_01JQ3KGHI",
  "object": "attendance.leave_request",
  "organization_id": "org_01HZXYZ",
  "user_id": "usr_01HZABC",
  "leave_type": "paid_leave",
  "start_date": "2026-03-01",
  "end_date": "2026-03-01",
  "reason": "Personal errands",
  "status": "approved",
  "created_at": "2026-02-20T11:00:00Z",
  "updated_at": "2026-02-21T09:00:00Z"
}