Sign in
Students

Create a new student

Changed on

Create a new student record

post/students

Request

  • Base URL: http://localhost:8080/api/v1
  • URL: http://localhost:8080/api/v1/students
  • Auth: none declared

Request body

first_namestring required

Student's first name

last_namestring required

Student's last name

dobstring date nullable

Student's date of birth (YYYY-MM-DD format, optional)

school_idinteger required

ID of the school the student attends

therapist_idstring uuid required

ID of the assigned therapist

gradeinteger nullable

Student's current grade level (optional). -1 = graduated, 0 = kindergarten, 1-12 = grades 1-12

iepstring[] nullable

List of Individualized Education Program goals (optional)

Example request

{
  "first_name": "John",
  "last_name": "Doe",
  "dob": "2010-05-15",
  "school_id": 3,
  "therapist_id": "987fcdeb-51a2-43d1-9f4c-123456789abc",
  "grade": 5,
  "iep": [
    "Active IEP with speech therapy goals",
    "Occupational therapy accommodations"
  ]
}

Response

Student created successfully

idstring uuid required

Unique identifier for the student

first_namestring required

Student's first name

last_namestring required

Student's last name

dobstring date-time

Student's date of birth

therapist_idstring uuid required

UUID of the assigned therapist

school_idinteger required

ID of the school the student attends

school_namestring nullable

Name of the school the student attends

district_idinteger nullable

ID of the school district the student belongs to

gradeinteger nullable

Student's current grade level. -1 = graduated, 0 = kindergarten, 1-12 = grades 1-12

iepstring[] nullable

List of Individualized Education Program goals

created_atstring date-time required

Timestamp when the student record was created

updated_atstring date-time required

Timestamp when the student record was last updated

Example response

{
  "id": "843d4807-1397-4227-9328-330adea56993",
  "first_name": "John",
  "last_name": "Doe",
  "dob": "2010-05-15T00:00:00Z",
  "therapist_id": "9dad94d8-6534-4510-90d7-e4e97c175a65",
  "school_id": 3,
  "school_name": "Generate High",
  "district_id": 2,
  "grade": 5,
  "iep": [
    "Active IEP with speech therapy goals",
    "Occupational therapy accommodations"
  ],
  "created_at": "2025-09-18T14:14:11.66268Z",
  "updated_at": "2025-09-18T14:14:11.66268Z"
}

Changes

  • ec921aa9dc08Revision changes
    • ▲

      the request property type changed from string to array

    • ▲

      the response's property type changed from string to array for status

  • e8df156eaed6Revision changes
    • ▲

      added the new required request property

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status