ClassCharts API Docs

List Pupils

Get a list of pupils connected to this parent's account

GET
/pupils
/pupils

The Authorization access token

Authorization

Authorization
Required
Basic <token>

This is the session_id returned when logging in. e.g. Basic eW91IHNob3VsZCBzdGFyIHRoaXMgcmVwbyE=

In: header

curl -X GET "https://www.classcharts.com/apiv2parent/pupils" \
  -H "Authorization: Basic <token>"

Array of pupils

[
  {
    "id": 0,
    "name": "string",
    "first_name": "string",
    "last_name": "string",
    "avatar_url": "string",
    "display_behaviour": true,
    "display_parent_behaviour": true,
    "display_homework": true,
    "display_rewards": true,
    "display_detentions": true,
    "display_report_cards": true,
    "display_classes": true,
    "display_announcements": true,
    "display_attendance": true,
    "display_attendance_type": "string",
    "display_attendance_percentage": true,
    "display_activity": true,
    "display_mental_health": true,
    "display_timetable": true,
    "is_disabled": true,
    "display_two_way_communications": true,
    "display_absences": true,
    "can_upload_attachments": true,
    "display_event_badges": true,
    "display_avatars": true,
    "display_concern_submission": true,
    "display_custom_fields": true,
    "pupil_concerns_help_text": "string",
    "allow_pupils_add_timetable_notes": true,
    "announcements_count": 0,
    "pusher_channel_name": "string",
    "has_birthday": true,
    "has_new_survey": true,
    "survey_id": 0,
    "detention_alias_plural_uc": "string",
    "school_name": "string",
    "school_logo": "string",
    "timezone": "string",
    "display_covid_tests": true,
    "can_record_covid_tests": true,
    "detention_yes_count": 0,
    "detention_no_count": 0,
    "detention_pending_count": 0,
    "detention_upscaled_count": 0,
    "homework_todo_count": 0,
    "homework_late_count": 0,
    "homework_not_completed_count": 0,
    "homework_excused_count": 0,
    "homework_completed_count": 0,
    "homework_submitted_count": 0,
    "messages_count": 0
  }
]