Relationships

This page describes all the APIs relating to relationships.

Get All Relationships

get

Retrieve all student-parent relationships in the school.

This endpoint returns a paginated list of students with their associated parent IDs, providing a mapping of family relationships within the school system.

The response includes:

• Student ID and their associated parent IDs

• Pagination metadata

This is useful for understanding family structures and parent-child relationships.

Authorizations

bearerAuth

Query parameters

pageinteger · min: 1Optional

The page number of results to return.

Default: 1

per_pageinteger · min: 1 · max: 200Optional

Request for how many records to return.

Default: 50

countintegerOptional

Synonym for per_page

Responses

401

Unauthorized

application/json

403

Forbidden

application/json

get

HTTPcURLJavaScriptPython

GET /api/v3/relationships HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "error": "Unauthorized access"
}

Get a Parent's Child Relationships

get

Fetch the associated children to the given parent

Authorizations

bearerAuth

Path parameters

idintegerRequired

Serial database ID used to refer to a unique parent record in OpenApply

Responses

200

successful

application/json

404

parent not found

get

HTTPcURLJavaScriptPython

GET /api/v3/relationships/parent/{id} HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "parent_id": 1,
  "student_ids": [
    1
  ]
}