Parents

Parents are users who are adults connected to students

Get all Parents

get
/v2/parents

This endpoint retrieves all parents. Returns an ID, personal details and the IDs of their associated students.

Authorizations
auth_tokenstringRequired

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

Query parameters
ids[]integer[]Optional

Return only records with the given IDs.

archivedbooleanOptional

Return only archived (1) or only active (0) parents. If value is not specified, all parents are returned.

modified_sincestringOptional

A timestamp to filter the modification date of results.

pagestringOptional

An integer defining which page to display.

per_pagestringOptional

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

deleted_sincestringOptional

A timestamp to filter the deletion date of results.

qstringOptional

A string to search across all fields for.

Responses
chevron-right
200

Success

application/json
get
/v2/parents
200

Success

Create New Parent

post
/v2/parents

This endpoint creates a new parent record. The Content-Type header must be set to application/json, and the request body should contain the field structure as a JSON payload. Note only users with the admin role are able to create users.

Authorizations
auth_tokenstringRequired

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

Body
parentall ofRequired
anyOptional
or
and
anyOptional

Fields for create parent

Responses
post
/v2/parents
201

Success

Get a Parent

get
/v2/parents/{id}

This endpoint retrieves a single parent as specified by ID. It returns personal details and the IDs of their associated students.

Authorizations
auth_tokenstringRequired

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

Path parameters
idintegerRequired

Unique identifier for a parent.

Responses
chevron-right
200

Success

application/json
get
/v2/parents/{id}
200

Success

Update a Parent

patch
/v2/parents/{id}

This endpoint updates a parent record as specified by ID. The Content-Type header must be set to application/json, and the request body should contain the fields you want to update as a JSON payload. Only users with the admin role are able to update users.

Authorizations
auth_tokenstringRequired

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

Path parameters
idintegerRequired

Unique identifier for a parent.

Body
parentall ofRequired
anyOptional
or
and
anyOptional

Fields for update parent

Responses
chevron-right
200

Success

application/json
patch
/v2/parents/{id}
200

Success

Archive a Parent

put
/v2/parents/{id}/archive

This endpoint archives a parent record as specified by ID. This effectively removes the parent from groups they are members of.

Authorizations
auth_tokenstringRequired

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

Path parameters
idintegerRequired

Unique identifier for a parent.

Responses
chevron-right
200

Success

application/json
put
/v2/parents/{id}/archive
200

Success

Unarchive a Parent

put
/v2/parents/{id}/unarchive

This endpoint reverses the archive operation on the parent record as specified by ID. This effectively restores the parent’s group memberships.

Authorizations
auth_tokenstringRequired

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

Path parameters
idintegerRequired

Unique identifier for a parent.

Responses
chevron-right
200

Success

application/json
put
/v2/parents/{id}/unarchive
200

Success

Last updated

Was this helpful?