# Parents

Parents are users who are adults connected to students

## Get all Parents

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

```json
{"openapi":"3.0.3","info":{"title":"API V2","version":"v2"},"tags":[{"name":"Parents","description":"Parents are users who are adults connected to students"}],"servers":[{"url":"https://api.managebac.com","description":"The ManageBac API server."},{"url":"https://api.{server}","variables":{"server":{"default":"managebac.com","enum":["managebac.com","managebac.cn","us.managebac.com"]}}}],"security":[{"authTokenHeader":[]},{"authTokenQuery":[]}],"components":{"securitySchemes":{"authTokenHeader":{"type":"apiKey","name":"auth-token","in":"header","description":"Pass your V2 API authentication in the header for best security."},"authTokenQuery":{"type":"apiKey","name":"auth_token","in":"query","description":"Your V2 API authentication token may be passed as a query parameter. For best security, pass via headers instead."}},"parameters":{"idsQueryParam":{"name":"ids[]","in":"query","description":"Return only records with the given IDs.","required":false,"allowReserved":true,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}}},"schemas":{"Parent":{"allOf":[{"$ref":"#/components/schemas/PersonalInformation"},{"type":"object","properties":{"id":{"type":"integer","description":"Unique ID for a parent in ManageBac."},"salutation":{"type":"string","description":"Parent/guardian’s title.","enum":["Mr.","Ms.","Mrs.","Dr."]},"title":{"type":"string","description":"Parent/guardian’s work position."},"employer":{"type":"string","description":"Parent/guardian’s employer."},"work_email":{"type":"string","description":"Parent/guardian’s work email address (may differ to email field)."},"work_phone":{"type":"string","description":"Parent/guardian’s work number."},"work_address":{"type":"string","description":"First line of parent/guardian’s work address."},"work_address_ii":{"type":"string","description":"Second (optional) line of parent/guardian’s work address."},"work_fax":{"type":"string","description":"Fax number for parent/guardian’s work"},"work_city":{"type":"string","description":"City of parent/guardian’s work address."},"work_state":{"type":"string","description":"State of parent/guardian’s work address."},"work_postal_code":{"type":"string","description":"Postal/zip code of parent/guardian’s work address."},"work_country":{"type":"string","description":"Country of parent/guardian’s address."},"sb_id":{"type":"string","description":"SchoolsBuddy uniq ID"},"oa_id":{"type":"sting","description":"OpenApply uniq ID"},"child_ids":{"type":"array","readOnly":true,"items":{"type":"integer"},"description":"Unique ID for offspring/wards of the parent/guardian."}}}]},"PersonalInformation":{"type":"object","properties":{"email":{"type":"string","description":"User’s work email address"},"first_name":{"type":"string","description":"User’s first given name."},"middle_name":{"type":"string","description":"User’s additional name."},"password":{"type":"string","description":"Minimum 6-character password."},"last_name":{"type":"string","description":"User’s surname."},"nickname":{"type":"string","description":"User’s handle (may differ to given name)."},"other_name":{"type":"string","description":"User’s additional names or variant in a different language."},"identifier":{"type":"string","description":"School’s own unique ID for user."},"gender":{"type":"string","description":"Binary gender."},"birthday":{"type":"string","description":"User’s dob; yyyy-mm-dd."},"phone_number":{"type":"string","description":"User’s home number."},"mobile_phone_number":{"type":"string","description":"User’s mobile number."},"street_address":{"type":"string","description":"First line of user’s home address."},"street_address_ii":{"type":"string","description":"Second (optional) line of user’s home address."},"city":{"type":"string","description":"City of user’s home address."},"state":{"type":"string","description":"State of user’s home address."},"zipcode":{"type":"string","description":"Postal/zip code of user’s home address."},"country":{"type":"string","description":"Country of user’s home address."},"nationalities":{"type":"array","description":"One or more nationalities of the user.","items":{"type":"string"}},"languages":{"type":"array","items":{"type":"string"},"description":"Fluent language/s of the user."},"account_uid":{"type":"string","readOnly":true,"description":"A user's Portal Account UID"},"timezone":{"type":"string","description":"The time zone of the user."}}},"Meta":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page."},"total_pages":{"type":"integer","description":"How many pages."},"total_count":{"type":"integer","description":"How many items."},"per_page":{"type":"integer","description":"How many items on page."}}}}},"paths":{"/v2/parents":{"get":{"summary":"Get all Parents","operationId":"listParents","tags":["Parents"],"description":"This endpoint retrieves all parents. Returns an ID, personal details and the IDs of their associated students.","parameters":[{"$ref":"#/components/parameters/idsQueryParam"},{"name":"archived","in":"query","description":"Return only archived (1) or only active (0) parents. If value is not specified, all parents are returned.","required":false,"schema":{"type":"boolean"}},{"name":"modified_since","in":"query","description":"A timestamp to filter the modification date of results.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"An integer defining which page to display.","required":false,"schema":{"type":"string"}},{"name":"per_page","in":"query","description":"An integer defining the number of records to display per page.","required":false,"schema":{"type":"string"}},{"name":"deleted_since","in":"query","description":"A timestamp to filter the deletion date of results.","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","description":"A string to search across all fields for.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"parents":{"type":"array","items":{"$ref":"#/components/schemas/Parent"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}}}}}}}}
```

## Create New Parent

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

```json
{"openapi":"3.0.3","info":{"title":"API V2","version":"v2"},"tags":[{"name":"Parents","description":"Parents are users who are adults connected to students"}],"servers":[{"url":"https://api.managebac.com","description":"The ManageBac API server."},{"url":"https://api.{server}","variables":{"server":{"default":"managebac.com","enum":["managebac.com","managebac.cn","us.managebac.com"]}}}],"security":[{"authTokenHeader":[]},{"authTokenQuery":[]}],"components":{"securitySchemes":{"authTokenHeader":{"type":"apiKey","name":"auth-token","in":"header","description":"Pass your V2 API authentication in the header for best security."},"authTokenQuery":{"type":"apiKey","name":"auth_token","in":"query","description":"Your V2 API authentication token may be passed as a query parameter. For best security, pass via headers instead."}},"schemas":{"Parent":{"allOf":[{"$ref":"#/components/schemas/PersonalInformation"},{"type":"object","properties":{"id":{"type":"integer","description":"Unique ID for a parent in ManageBac."},"salutation":{"type":"string","description":"Parent/guardian’s title.","enum":["Mr.","Ms.","Mrs.","Dr."]},"title":{"type":"string","description":"Parent/guardian’s work position."},"employer":{"type":"string","description":"Parent/guardian’s employer."},"work_email":{"type":"string","description":"Parent/guardian’s work email address (may differ to email field)."},"work_phone":{"type":"string","description":"Parent/guardian’s work number."},"work_address":{"type":"string","description":"First line of parent/guardian’s work address."},"work_address_ii":{"type":"string","description":"Second (optional) line of parent/guardian’s work address."},"work_fax":{"type":"string","description":"Fax number for parent/guardian’s work"},"work_city":{"type":"string","description":"City of parent/guardian’s work address."},"work_state":{"type":"string","description":"State of parent/guardian’s work address."},"work_postal_code":{"type":"string","description":"Postal/zip code of parent/guardian’s work address."},"work_country":{"type":"string","description":"Country of parent/guardian’s address."},"sb_id":{"type":"string","description":"SchoolsBuddy uniq ID"},"oa_id":{"type":"sting","description":"OpenApply uniq ID"},"child_ids":{"type":"array","readOnly":true,"items":{"type":"integer"},"description":"Unique ID for offspring/wards of the parent/guardian."}}}]},"PersonalInformation":{"type":"object","properties":{"email":{"type":"string","description":"User’s work email address"},"first_name":{"type":"string","description":"User’s first given name."},"middle_name":{"type":"string","description":"User’s additional name."},"password":{"type":"string","description":"Minimum 6-character password."},"last_name":{"type":"string","description":"User’s surname."},"nickname":{"type":"string","description":"User’s handle (may differ to given name)."},"other_name":{"type":"string","description":"User’s additional names or variant in a different language."},"identifier":{"type":"string","description":"School’s own unique ID for user."},"gender":{"type":"string","description":"Binary gender."},"birthday":{"type":"string","description":"User’s dob; yyyy-mm-dd."},"phone_number":{"type":"string","description":"User’s home number."},"mobile_phone_number":{"type":"string","description":"User’s mobile number."},"street_address":{"type":"string","description":"First line of user’s home address."},"street_address_ii":{"type":"string","description":"Second (optional) line of user’s home address."},"city":{"type":"string","description":"City of user’s home address."},"state":{"type":"string","description":"State of user’s home address."},"zipcode":{"type":"string","description":"Postal/zip code of user’s home address."},"country":{"type":"string","description":"Country of user’s home address."},"nationalities":{"type":"array","description":"One or more nationalities of the user.","items":{"type":"string"}},"languages":{"type":"array","items":{"type":"string"},"description":"Fluent language/s of the user."},"account_uid":{"type":"string","readOnly":true,"description":"A user's Portal Account UID"},"timezone":{"type":"string","description":"The time zone of the user."}}}}},"paths":{"/v2/parents":{"post":{"summary":"Create New Parent","operationId":"createParent","tags":["Parents"],"description":"This endpoint creates a new parent record. The <code>Content-Type</code> header must be set to <code>application/json</code>, and the request body should contain the field structure as a JSON payload. <b>Note</b> only users with the <code>admin</code> <code>role</code> are able to create users.","parameters":[],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"parent":{"$ref":"#/components/schemas/Parent"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parent":{"allOf":[{"$ref":"#/components/schemas/Parent"},{"description":"Fields for create parent"}]}},"required":["parent"]}}}}}}}}
```

## Get a Parent

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

```json
{"openapi":"3.0.3","info":{"title":"API V2","version":"v2"},"tags":[{"name":"Parents","description":"Parents are users who are adults connected to students"}],"servers":[{"url":"https://api.managebac.com","description":"The ManageBac API server."},{"url":"https://api.{server}","variables":{"server":{"default":"managebac.com","enum":["managebac.com","managebac.cn","us.managebac.com"]}}}],"security":[{"authTokenHeader":[]},{"authTokenQuery":[]}],"components":{"securitySchemes":{"authTokenHeader":{"type":"apiKey","name":"auth-token","in":"header","description":"Pass your V2 API authentication in the header for best security."},"authTokenQuery":{"type":"apiKey","name":"auth_token","in":"query","description":"Your V2 API authentication token may be passed as a query parameter. For best security, pass via headers instead."}},"schemas":{"Parent":{"allOf":[{"$ref":"#/components/schemas/PersonalInformation"},{"type":"object","properties":{"id":{"type":"integer","description":"Unique ID for a parent in ManageBac."},"salutation":{"type":"string","description":"Parent/guardian’s title.","enum":["Mr.","Ms.","Mrs.","Dr."]},"title":{"type":"string","description":"Parent/guardian’s work position."},"employer":{"type":"string","description":"Parent/guardian’s employer."},"work_email":{"type":"string","description":"Parent/guardian’s work email address (may differ to email field)."},"work_phone":{"type":"string","description":"Parent/guardian’s work number."},"work_address":{"type":"string","description":"First line of parent/guardian’s work address."},"work_address_ii":{"type":"string","description":"Second (optional) line of parent/guardian’s work address."},"work_fax":{"type":"string","description":"Fax number for parent/guardian’s work"},"work_city":{"type":"string","description":"City of parent/guardian’s work address."},"work_state":{"type":"string","description":"State of parent/guardian’s work address."},"work_postal_code":{"type":"string","description":"Postal/zip code of parent/guardian’s work address."},"work_country":{"type":"string","description":"Country of parent/guardian’s address."},"sb_id":{"type":"string","description":"SchoolsBuddy uniq ID"},"oa_id":{"type":"sting","description":"OpenApply uniq ID"},"child_ids":{"type":"array","readOnly":true,"items":{"type":"integer"},"description":"Unique ID for offspring/wards of the parent/guardian."}}}]},"PersonalInformation":{"type":"object","properties":{"email":{"type":"string","description":"User’s work email address"},"first_name":{"type":"string","description":"User’s first given name."},"middle_name":{"type":"string","description":"User’s additional name."},"password":{"type":"string","description":"Minimum 6-character password."},"last_name":{"type":"string","description":"User’s surname."},"nickname":{"type":"string","description":"User’s handle (may differ to given name)."},"other_name":{"type":"string","description":"User’s additional names or variant in a different language."},"identifier":{"type":"string","description":"School’s own unique ID for user."},"gender":{"type":"string","description":"Binary gender."},"birthday":{"type":"string","description":"User’s dob; yyyy-mm-dd."},"phone_number":{"type":"string","description":"User’s home number."},"mobile_phone_number":{"type":"string","description":"User’s mobile number."},"street_address":{"type":"string","description":"First line of user’s home address."},"street_address_ii":{"type":"string","description":"Second (optional) line of user’s home address."},"city":{"type":"string","description":"City of user’s home address."},"state":{"type":"string","description":"State of user’s home address."},"zipcode":{"type":"string","description":"Postal/zip code of user’s home address."},"country":{"type":"string","description":"Country of user’s home address."},"nationalities":{"type":"array","description":"One or more nationalities of the user.","items":{"type":"string"}},"languages":{"type":"array","items":{"type":"string"},"description":"Fluent language/s of the user."},"account_uid":{"type":"string","readOnly":true,"description":"A user's Portal Account UID"},"timezone":{"type":"string","description":"The time zone of the user."}}}}},"paths":{"/v2/parents/{id}":{"get":{"summary":"Get a Parent","operationId":"getParentByID","tags":["Parents"],"description":"This endpoint retrieves a single parent as specified by ID. It returns personal details and the IDs of their associated students.","parameters":[{"name":"id","in":"path","description":"Unique identifier for a parent.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"parent":{"$ref":"#/components/schemas/Parent"}}}}}}}}}}}
```

## Update a Parent

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

```json
{"openapi":"3.0.3","info":{"title":"API V2","version":"v2"},"tags":[{"name":"Parents","description":"Parents are users who are adults connected to students"}],"servers":[{"url":"https://api.managebac.com","description":"The ManageBac API server."},{"url":"https://api.{server}","variables":{"server":{"default":"managebac.com","enum":["managebac.com","managebac.cn","us.managebac.com"]}}}],"security":[{"authTokenHeader":[]},{"authTokenQuery":[]}],"components":{"securitySchemes":{"authTokenHeader":{"type":"apiKey","name":"auth-token","in":"header","description":"Pass your V2 API authentication in the header for best security."},"authTokenQuery":{"type":"apiKey","name":"auth_token","in":"query","description":"Your V2 API authentication token may be passed as a query parameter. For best security, pass via headers instead."}},"schemas":{"Parent":{"allOf":[{"$ref":"#/components/schemas/PersonalInformation"},{"type":"object","properties":{"id":{"type":"integer","description":"Unique ID for a parent in ManageBac."},"salutation":{"type":"string","description":"Parent/guardian’s title.","enum":["Mr.","Ms.","Mrs.","Dr."]},"title":{"type":"string","description":"Parent/guardian’s work position."},"employer":{"type":"string","description":"Parent/guardian’s employer."},"work_email":{"type":"string","description":"Parent/guardian’s work email address (may differ to email field)."},"work_phone":{"type":"string","description":"Parent/guardian’s work number."},"work_address":{"type":"string","description":"First line of parent/guardian’s work address."},"work_address_ii":{"type":"string","description":"Second (optional) line of parent/guardian’s work address."},"work_fax":{"type":"string","description":"Fax number for parent/guardian’s work"},"work_city":{"type":"string","description":"City of parent/guardian’s work address."},"work_state":{"type":"string","description":"State of parent/guardian’s work address."},"work_postal_code":{"type":"string","description":"Postal/zip code of parent/guardian’s work address."},"work_country":{"type":"string","description":"Country of parent/guardian’s address."},"sb_id":{"type":"string","description":"SchoolsBuddy uniq ID"},"oa_id":{"type":"sting","description":"OpenApply uniq ID"},"child_ids":{"type":"array","readOnly":true,"items":{"type":"integer"},"description":"Unique ID for offspring/wards of the parent/guardian."}}}]},"PersonalInformation":{"type":"object","properties":{"email":{"type":"string","description":"User’s work email address"},"first_name":{"type":"string","description":"User’s first given name."},"middle_name":{"type":"string","description":"User’s additional name."},"password":{"type":"string","description":"Minimum 6-character password."},"last_name":{"type":"string","description":"User’s surname."},"nickname":{"type":"string","description":"User’s handle (may differ to given name)."},"other_name":{"type":"string","description":"User’s additional names or variant in a different language."},"identifier":{"type":"string","description":"School’s own unique ID for user."},"gender":{"type":"string","description":"Binary gender."},"birthday":{"type":"string","description":"User’s dob; yyyy-mm-dd."},"phone_number":{"type":"string","description":"User’s home number."},"mobile_phone_number":{"type":"string","description":"User’s mobile number."},"street_address":{"type":"string","description":"First line of user’s home address."},"street_address_ii":{"type":"string","description":"Second (optional) line of user’s home address."},"city":{"type":"string","description":"City of user’s home address."},"state":{"type":"string","description":"State of user’s home address."},"zipcode":{"type":"string","description":"Postal/zip code of user’s home address."},"country":{"type":"string","description":"Country of user’s home address."},"nationalities":{"type":"array","description":"One or more nationalities of the user.","items":{"type":"string"}},"languages":{"type":"array","items":{"type":"string"},"description":"Fluent language/s of the user."},"account_uid":{"type":"string","readOnly":true,"description":"A user's Portal Account UID"},"timezone":{"type":"string","description":"The time zone of the user."}}}}},"paths":{"/v2/parents/{id}":{"patch":{"summary":"Update a Parent","operationId":"updateParent","tags":["Parents"],"description":"This endpoint updates a parent record as specified by ID. The <code>Content-Type</code> header must be set to <code>application/json</code>, and the request body should contain the fields you want to update as a JSON payload.</br>Only users with the <code>admin</code> <code>role</code> are able to update users.","parameters":[{"name":"id","in":"path","description":"Unique identifier for a parent.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"parent":{"$ref":"#/components/schemas/Parent"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parent":{"allOf":[{"$ref":"#/components/schemas/Parent"},{"description":"Fields for update parent"}]}},"required":["parent"]}}}}}}}}
```

## Archive a Parent

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

```json
{"openapi":"3.0.3","info":{"title":"API V2","version":"v2"},"tags":[{"name":"Parents","description":"Parents are users who are adults connected to students"}],"servers":[{"url":"https://api.managebac.com","description":"The ManageBac API server."},{"url":"https://api.{server}","variables":{"server":{"default":"managebac.com","enum":["managebac.com","managebac.cn","us.managebac.com"]}}}],"security":[{"authTokenHeader":[]},{"authTokenQuery":[]}],"components":{"securitySchemes":{"authTokenHeader":{"type":"apiKey","name":"auth-token","in":"header","description":"Pass your V2 API authentication in the header for best security."},"authTokenQuery":{"type":"apiKey","name":"auth_token","in":"query","description":"Your V2 API authentication token may be passed as a query parameter. For best security, pass via headers instead."}}},"paths":{"/v2/parents/{id}/archive":{"put":{"summary":"Archive a Parent","operationId":"archiveParent","tags":["Parents"],"description":"This endpoint archives a parent record as specified by ID. This effectively removes the parent from groups they are members of.","parameters":[{"name":"id","in":"path","description":"Unique identifier for a parent.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{}}}}}}}}
```

## Unarchive a Parent

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

```json
{"openapi":"3.0.3","info":{"title":"API V2","version":"v2"},"tags":[{"name":"Parents","description":"Parents are users who are adults connected to students"}],"servers":[{"url":"https://api.managebac.com","description":"The ManageBac API server."},{"url":"https://api.{server}","variables":{"server":{"default":"managebac.com","enum":["managebac.com","managebac.cn","us.managebac.com"]}}}],"security":[{"authTokenHeader":[]},{"authTokenQuery":[]}],"components":{"securitySchemes":{"authTokenHeader":{"type":"apiKey","name":"auth-token","in":"header","description":"Pass your V2 API authentication in the header for best security."},"authTokenQuery":{"type":"apiKey","name":"auth_token","in":"query","description":"Your V2 API authentication token may be passed as a query parameter. For best security, pass via headers instead."}}},"paths":{"/v2/parents/{id}/unarchive":{"put":{"summary":"Unarchive a Parent","operationId":"unarchiveParent","tags":["Parents"],"description":"This endpoint reverses the archive operation on the parent record as specified by ID. This effectively restores the parent’s group memberships.","parameters":[{"name":"id","in":"path","description":"Unique identifier for a parent.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{}}}}}}}}
```
