Relationships

A relationship defines the kind of association between a student and a parent

List of parent-children relationships

get
/v2/parents/{parent_id}/children

This endpoint retrieves all children relationships of parent

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
parent_idstringRequired

An integer of child's Parent ID

Query parameters
pagestringOptional

An integer defining which page to display.

per_pagestringOptional

An integer defining the number of records to display per page.

Responses
200

Success

application/json
get
/v2/parents/{parent_id}/children
200

Success

Create a parent-child relationship

post
/v2/parents/{parent_id}/children

This endpoint creates parent-child relationship

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
parent_idstringRequired

An integer of child's Parent ID

Body
Responses
post
/v2/parents/{parent_id}/children

Bulk update a parent-children relationships

put
/v2/parents/{parent_id}/children

This endpoint updates all parent-children relationships

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
parent_idstringRequired

An integer of child's Parent ID

Body
Responses
200

Success

application/json
put
/v2/parents/{parent_id}/children

Get parent-child relationship

get
/v2/parents/{parent_id}/children/{id}

This endpoint retrieves all information about child relationship to parent

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
parent_idstringRequired

An integer of child's Parent ID

idstringRequired

An integer of child ID

Responses
200

Success

application/json
get
/v2/parents/{parent_id}/children/{id}

Update parent-child relationship

put
/v2/parents/{parent_id}/children/{id}

This endpoint updates parent-child relationship

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
parent_idstringRequired

An integer of child's Parent ID

idstringRequired

An integer of child ID

Body
Responses
200

Success

application/json
put
/v2/parents/{parent_id}/children/{id}

Remove parent-child relationship

delete
/v2/parents/{parent_id}/children/{id}

This endpoint removes child relationship to parent

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
parent_idstringRequired

An integer of child's Parent ID

idstringRequired

An integer of child ID

Responses
delete
/v2/parents/{parent_id}/children/{id}

No content

Last updated

Was this helpful?