List Parents | SchoolSet

curl https://app.schoolset.io/app/api/v1/parents \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Parent records retrieved successfully.",
  "data": [
    {
      "id": 1024,
      "firstname": "Rachel",
      "firstname_hebrew": "רחל",
      "lastname": "Levin",
      "lastname_hebrew": "לוין",
      "dob": "1975-08-12",
      "dob_hebrew": "12 Av 5735",
      "full_name": "Rachel Levin",
      "type": {
        "id": 2,
        "title": "Mother"
      },
      "email": "rachel.levin@example.com",
      "home_phone": "+1-212-555-0198",
      "cell_phone": "+1-917-555-0147",
      "work_phone": "+1-212-555-0112",
      "maiden_name": "Goldberg",
      "family_student_id": 5678,
      "addresses": [
        {
          "id": 301,
          "components": [
            "123 Maple Street",
            "Apt 4B",
            "Brooklyn",
            "NY",
            "11201",
            "USA"
          ],
          "splitted": [
            "123 Maple Street",
            "Apt 4B",
            "Brooklyn",
            "NY",
            "11201",
            "USA"
          ],
          "formatted": "123 Maple Street, Apt 4B, Brooklyn, NY 11201, USA",
          "longitude": -73.9442,
          "latitude": 40.6782,
          "tag": "Home"
        }
      ],
      "prefix": "Ms.",
      "marital_status": {
        "id": 1,
        "title": "Married"
      },
      "suffix": null,
      "hebrew_prefix": "גברת",
      "hebrew_suffix": null,
      "job_title": "Project Manager",
      "occupation": "Information Technology",
      "employer": "Tech Solutions Inc."
    }
  ]
}

Lists parent records for the active school context.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Response

JSON response payload for the parent collection.

statusenum

Allowed values:

messagestring

datalist of objects