Relationships

This page describes all the APIs relating to relationships.

List All Relationships

get

https://api.openapply.comhttps://api.openapply.cn

/api/v3/relationships

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

200

successful

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/api/v3/relationships

HTTPcURLJavaScriptPython

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

{
  "relationships": [
    {
      "parent_id": 1,
      "student_ids": [
        1
      ],
      "relationships": [
        {
          "student_id": 1,
          "relationship": "text"
        }
      ]
    }
  ],
  "meta": {
    "pages": 1,
    "per_page": 1
  }
}

Get a Parent's Child Relationships

get

https://api.openapply.comhttps://api.openapply.cn

/api/v3/relationships/parent/{id}

Fetch the associated children to the given parent

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

/api/v3/relationships/parent/{id}

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
  ],
  "relationships": [
    {
      "student_id": 1,
      "relationship": "text"
    }
  ]
}

Update a Parent-Student Relationship

put

https://api.openapply.comhttps://api.openapply.cn

/api/v3/relationships/parent/{id}

Update the relationships between a parent and their children. Accepts an array of relationship objects, each specifying a student_id and an optional relationship role.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

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

Body

application/json

Responses

200

successful

application/json

422

unprocessable entity

application/json

put

/api/v3/relationships/parent/{id}

HTTPcURLJavaScriptPython

PUT /api/v3/relationships/parent/{id} HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "relationships": [
    {
      "student_id": 1,
      "relationship": "text"
    }
  ]
}

{
  "student_ids": [
    1
  ],
  "relationships": [
    {
      "student_id": 1,
      "relationship": "text"
    }
  ]
}

Get a Student's Parent Relationships

get

https://api.openapply.comhttps://api.openapply.cn

/api/v3/relationships/student/{id}

Fetch the associated parents and relationship roles for the given student.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

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

Responses

200

successful

application/json

404

student not found

get

/api/v3/relationships/student/{id}

HTTPcURLJavaScriptPython

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

{
  "parent_id": 1,
  "student_ids": [
    1
  ],
  "relationships": [
    {
      "student_id": 1,
      "relationship": "text"
    }
  ]
}