Sign in
Admin - Schools

Export Teacher Emails

Export teacher emails. Filter modes:

  • 'active': Teachers from schools with active B2B contracts
  • 'any_school': Teachers from any school (active or inactive)
  • 'all': All teachers in the system (with or without school) Optional contract_type filter: free, pilot, paid Optional usage_filter: 'any' (all), 'some' (has usage), 'none' (no usage) Returns preview (count + sample) or CSV download.
get/admin/schools/export-teacher-emails

Query parameters

filter_mode'active' | 'any_school' | 'all'

Filter mode: 'active' (active contracts only), 'any_school' (any school), 'all' (all teachers)

Filter mode: 'active' (active contracts only), 'any_school' (any school), 'all' (all teachers)

contract_type'free' | 'pilot' | 'paid' nullable

Filter by contract type (only applies when filter_mode is 'active' or 'any_school')

Filter by contract type (only applies when filter_mode is 'active' or 'any_school')

usage_filter'any' | 'some' | 'none'

Filter by platform usage: 'any' (no filter), 'some' (has usage), 'none' (no usage)

Filter by platform usage: 'any' (no filter), 'some' (has usage), 'none' (no usage)

downloadboolean

Set to true to download CSV

Set to true to download CSV

Response

CSV file when download=true

countinteger required
sample_emailsstring[] required

Changes

No recorded changes to this endpoint across all 1 revision of this API.