Skip to main content

Open API - Read Improvements (list filters + new read endpoints)

Release date: July 2026

Affected product: Orah Open API

Status: Live in all regions

Type: Additive - no breaking changes, no key re-issue required

TL;DR

We've made the Open API a lot easier to read from. You can now filter the student list instead of pulling everyone, look up a single staff member by your own ID, and enumerate a school's groups and reason codes — plus pull a student's day-by-day attendance the way the school's own dashboard computes it. Everything works with your existing API keys, and existing calls behave exactly as before.

Full request/response examples and field references live in the Open API docs — use the one for your region:

  • Americas: https://open-api-virginia.orah.com/open-api/

  • Asia-Pacific: https://open-api-sydney.orah.com/open-api/

  • Europe / Africa / Middle East: https://open-api-ireland.orah.com/open-api/

What's new

  • Filter the student list - narrow by house, group, year level or student type, with optional pagination for large schools. Send no new parameters and nothing changes.

  • Look up one staff member - resolve a single staff record by Orah ID or your SIS ID, instead of downloading the whole roster.

  • List groups - enumerate classes, advisories, athletics and more, filterable by type, each with its SIS ID.

  • List reason codes - pull a school's attendance reason codes so you can map them to your own.

  • Daily attendance timeline - a student's per-day attendance rollup, including SIS-sourced records, matching the school's daily policy.

Good to know

  • Additive only - no endpoints were changed, so existing integrations are unaffected and no key re-issue is needed.

- Student-anchored endpoints accept either an Orah ID or your SIS ID.

Changelog

  • Modified student/list - added house / group / year_level / student_type filters and opt-in pagination.

  • New staff/get-single - single staff lookup by id or sis_id.

  • New group/list - list groups, filterable by type.

  • New reason-code/list - list and filter a school's reason codes.

  • New daily-attendance/timeline - per-student, per-day attendance rollup.

New Feature