Guardian

Operations related to guardian member management

Get guardian members

get
/guardian

Retrieve a list of guardian members with optional filtering and pagination

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageNumberinteger · min: 1Optional

Page number for pagination

Default: 1
pageSizeinteger · min: 1 · max: 100Optional

Number of items per page

Default: 10
guardianIdstring · uuidOptional

Filter by guardian ID

guardianEmailstring · emailOptional

Filter by guardian email

guardianFullNamestringOptional

Filter by guardian full name

statusstring · enumOptional

Filter by status

Possible values:
sortBystringOptional

Field to sort by

sortOrderstring · enumOptional

Sort order (asc/desc)

Possible values:
Responses
get
/guardian

Create guardian member

post
/guardian

Create a new guardian member and associate with a child member

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
guardianEmailstring · emailRequired

Guardian's email address

guardianFullNamestringRequired

Guardian's full name

guardianPhonestringOptional

Guardian's phone number

guardianAddressstringOptional

Guardian's address

memberIdstring · uuidRequired

ID of the child member

memberNamestringRequired

Name of the child member

Responses
post
/guardian

Update guardian member

put
/guardian/{guardianId}

Update an existing guardian member

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
guardianIdstring · uuidRequired

The ID of the guardian to update

Body
guardianEmailstring · emailOptional

Guardian's email address

guardianFullNamestringOptional

Guardian's full name

guardianPhonestringOptional

Guardian's phone number

guardianAddressstringOptional

Guardian's address

statusstring · enumOptional

Guardian account status

Possible values:
Responses
put
/guardian/{guardianId}

Get guardian self information

get
/guardian/self

Get current guardian member information

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
get
/guardian/self

Update guardian password

put
/guardian/password

Update guardian member password

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
currentPasswordstringRequired

Current password

newPasswordstringRequired

New password

confirmPasswordstringRequired

Confirm new password

Responses
put
/guardian/password

Resend account information email

post
/guardian/resend-account-info

Resend guardian account information email with new password

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
guardianIdstring · uuidRequired

Guardian ID to resend account information

Responses
post
/guardian/resend-account-info

Last updated