Skip to main content

Veracross scope reference

Every Veracross OAuth scope Orah uses, what it reads or writes, and which sync object needs it.

Every scope Orah uses, what it reads or writes, and which sync object needs it. This page is for IT staff and our support team working out why one sync is failing. If you are setting the integration up for the first time, start with How to enable and use the Veracross integration instead.

Scope

What Orah uses it for

Sync object

students:list

Student records, divisions and grade levels

Student, Division

households:list

Student, contact and staff addresses

Student, Contact, Staff

parents:list

Requested alongside contact data

Student, Contact

contact_info:list

Phone and email for students, contacts and staff

Student, Contact, Staff

relationships:list

Guardian links and relationship types

Student, Contact

staff_faculty:list

Staff records, roles and faculty types

Staff, Groups

academics.config.grading_periods:list

Terms and grading periods

School Year

classes:list

Class and team records

Groups, Pass record, Attendance History

academics.enrollments:list

Class rosters, and course types for every group sync

Groups

academics.courses:list

Course classifications used to include or exclude classes

Groups

athletics.rosters:list

Team rosters

Groups, Athletics type

programs.enrollments:list

Program rosters

Groups, Programs type

programs.classes.meeting_times:list

Program session times

Groups, Programs type

academics.classes.meeting_times:list

Class timetable

Schedules, Pass record

athletics.team.practice_schedules:list

Practice times

Schedules

class_permissions:list

Additional teachers permitted on a class, so a co-taught class appears on both teachers' schedules

Schedules

classes.attendance:list

Class attendance records and your reason codes

Reason Code, Attendance History, Roll Record, Pass record

classes.attendance:update

Writes class attendance back to Veracross

Roll Record, Pass record

academics.class_attendance_statuses:list

Reads whether a class has had attendance taken

Roll Record, Pass record

academics.class_attendance_statuses:update

Marks a class as having had attendance taken

Roll Record, Pass record

master_attendance:list

Reads day level attendance

Roll Record, Pass record

master_attendance:update

Writes day level attendance

Roll Record, Pass record

events.group_events:list

School event records

Groups Events type, Roll Record

events.athletics:list

Athletic fixtures

Groups Events type, Roll Record

event_groups_members:list

Event participants, and your event type list

Groups Events type, Roll Record

events.event_attendance:list

Reads event attendance

Roll Record, Pass record

events.event_attendance:create

Creates event attendance

Roll Record, Pass record

events.event_attendance:update

Updates event attendance

Roll Record, Pass record

events.event_attendance:delete

Removes event attendance

Roll Record, Pass record

events.event_attendance:read

Requested alongside the event attendance set

Roll Record, Pass record

extended_care.classes:list

Extended Care groups

Groups, Extended Care type

extended_care.registrations:list

Extended Care enrolments

Groups, Extended Care type

extended_care.classes.meeting_times:list

Extended Care session times

Groups, Extended Care type

boarding.dorms:list

Houses and dorms

House

boarding.dorms.students:list

House assignments, and boarder detection

House

academics.rooms:list

Rooms and location types

Location

person_photos:list

Student and staff profile photos

Student, Staff

Did this answer your question?