Attendance

This group describes all the APIs relating to attendance records

Get Attendance for a Class during an Academic Term

get
/v2p1/classes/{id}/attendance/term/{term_id}

This endpoint retrieves summary attendance data for all students within a class as specified by class ID for an academic term as specified by term ID.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
idintegerRequired

Unique identifier for class.

term_idintegerRequired

Unique identifier for academic term.

Query parameters
archived_studentsbooleanOptional

Filter students by archived status

Default: false
Responses
get
/v2p1/classes/{id}/attendance/term/{term_id}
200

Success

Get Class Attendance for a Date

get
/v2p1/classes/{id}/attendance/date/{date}

This endpoint retrieves summary attendance data for all students on a given date, as specified by class ID. Note, the specified date must be between the class’s start and end dates. A student’s attendance is returned as a sparse array of attendance periods. For further information, see the help article.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
idintegerRequired

Unique identifier for class.

datestringRequired

A date string to define required day as yyyy-mm-dd.

Responses
get
/v2p1/classes/{id}/attendance/date/{date}
200

Success

Set or Update a Class Attendance for Students

put
/v2p1/classes/{id}/attendance

This endpoint creates or Updates the Attendance records according to the provided payload. If an Attendance record for a specific student, date, and period already exists, it will be updated; otherwise, a new record will be created.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
idintegerRequired

Unique identifier for class.

Body
Responses
put
/v2p1/classes/{id}/attendance
200

Success

Get Class timetable

get
/v2p1/classes/{id}/timetable

This endpoint retrieves a class timetable specified by class ID.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
idintegerRequired

Unique identifier for class.

Query parameters
include_disabledbooleanOptional

Configure response to include or exclude disabled slots.

Responses
get
/v2p1/classes/{id}/timetable
200

Success

Get all Attendance Excusals for a date

get
/v2p1/students/excusals/{date}

Retrieve submitted excusals for a students for a date. Responses include dates the excusal applies to and comment given as submitted.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
datestringRequired

A date string to define required day as yyyy-mm-dd.

Query parameters
pagestringOptional

An integer defining which page to display.

per_pagestringOptional

An integer defining the number of records to display per page.

Responses
get
/v2p1/students/excusals/{date}
200

Success

Get Homeroom Attendance for a Year Group and Term

get
/v2p1/year-groups/{year_group_id}/homeroom/attendance/term/{term_id}

This endpoint retrieves homeroom attendance for students belonging to a year group. Attendance is retrieved by academic term, as specified by academic term ID.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
year_group_idintegerRequired

Unique identifier for year group.

term_idintegerRequired

Unique identifier for academic term.

Query parameters
archived_studentsbooleanOptional

Filter students by archived status

Default: false
Responses
get
/v2p1/year-groups/{year_group_id}/homeroom/attendance/term/{term_id}
200

Success

Get Homeroom Attendance for a Year Group by Date

get
/v2p1/year-groups/{year_group_id}/homeroom/attendance/date/{date}

This endpoint retrieves homeroom attendance for students as specified by year group ID and date.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
year_group_idintegerRequired

Unique identifier for year group.

datestringRequired

A date string

Responses
get
/v2p1/year-groups/{year_group_id}/homeroom/attendance/date/{date}
200

Success

Get Homeroom Attendance Adjustments for a Year Group and Term

get
/v2p1/year-groups/{year_group_id}/homeroom/attendance/term/{term_id}/adjustments

This endpoint retrieves Year Group Attendance Adjustments for a reporting term. Attendance adjustments is retrieved by academic term, as specified by academic term ID.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
year_group_idintegerRequired

Unique identifier for year group.

term_idintegerRequired

Unique identifier for academic term.

Responses
get
/v2p1/year-groups/{year_group_id}/homeroom/attendance/term/{term_id}/adjustments
200

Success

Get all Attendance Excusals for a student

get
/v2p1/students/{student_id}/excusals

Retrieve Attendance Excusals submitted by a parent for their child. Responses include dates the excusal applies to and comment given as submitted.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
student_idintegerRequired

Unique identifier for a student.

Query parameters
applies_onstringOptional

A date string to define required day as yyyy-mm-dd.

pagestringOptional

An integer defining which page to display.

per_pagestringOptional

An integer defining the number of records to display per page.

Responses
get
/v2p1/students/{student_id}/excusals
200

Success

Create Excusal for a Student

post
/v2p1/students/{student_id}/excusals

This endpoint creates an Attendance Excusal for a Student. It returns created Attendance Excusal.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
student_idintegerRequired

Unique identifier for a student.

Body
Responses
201

Created

application/json
post
/v2p1/students/{student_id}/excusals

Delete Excusal for a Student

delete
/v2p1/students/{student_id}/excusals/{id}

This endpoint deletes an Attendance Excusal for a Student. It returns deleted Attendance Excusal.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
student_idintegerRequired

Unique identifier for a student.

idintegerRequired

Unique identifier for an excusal.

Responses
delete
/v2p1/students/{student_id}/excusals/{id}
200

Success

Update Excusal for a Student

patch
/v2p1/students/{student_id}/excusals/{id}

This endpoint updates an Attendance Excusal for a Student. It returns updated Attendance Excusal.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
student_idintegerRequired

Unique identifier for a student.

idintegerRequired

Unique identifier for an excusal.

Body
Responses
patch
/v2p1/students/{student_id}/excusals/{id}

Set student homeroom attendance

put
/v2p1/students/{id}/set_homeroom_attendance

Sets student homeroom attendance record. If record doesn't exist, it will be created.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
idintegerRequired

Unique identifier for a student.

Body
datestring · dateOptional

Attendance date

statusinteger · enumOptional

Available statuses:
0 - Absent
1 - Present
2 - Late
3 - Dress Code
4 - Late & Dress Code
5 - Dismissed
10 - Health
11 - Sports
12 - Fieldtrip
13 - Excused
14 - Other
15 - Custom 1
16 - Custom 2
17 - Custom 3
18 - Custom 4

Possible values:
notesstringOptional

Attendance notes

Responses
put
/v2p1/students/{id}/set_homeroom_attendance
200

Success

Last updated

Was this helpful?