Parents
Parents are users who are adults connected to students
This endpoint retrieves all parents. Returns an ID, personal details and the IDs of their associated students.
Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.
Return only records with the given IDs.
Return only archived (1) or only active (0) parents. If value is not specified, all parents are returned.
A timestamp to filter the modification date of results.
An integer defining which page to display.
An integer defining the number of records to display per page.
A timestamp to filter the deletion date of results.
A string to search across all fields for.
Success
GET /v2/parents HTTP/1.1
Host: api.devel.managebac.com
Accept: */*
Success
{
"parents": [
{
"id": 2020,
"email": "[email protected]",
"first_name": "Kevin",
"last_name": "Dixon",
"identifier": "AA1001",
"archived": false,
"ui_language": "en",
"gender": "Male",
"timezone": "Europe/Kyiv",
"child_ids": [],
"children": [],
"street_address": "714 Hoard Terrace",
"city": "Menlo Park",
"state": "33117",
"zipcode": "65092",
"country": "PG",
"nationalities": [],
"languages": [],
"role": "Parent"
}
],
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"per_page": 100
}
}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.
Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.
Fields for create parent
Success
POST /v2/parents HTTP/1.1
Host: api.devel.managebac.com
Content-Type: application/json
Accept: */*
Content-Length: 860
{
"parent": {
"email": "[email protected]",
"first_name": "Richard",
"middle_name": "David",
"password": "qwerty9876",
"last_name": "Chandler",
"nickname": "Ricky",
"other_name": "",
"identifier": "AA1001",
"gender": "Male",
"birthday": "1972-10-24",
"phone_number": "977 840-2231",
"mobile_phone_number": "977 840-2231",
"street_address": "301 Massachusetts Ave",
"street_address_ii": "",
"city": "Lunenburg",
"state": "Virginia",
"zipcode": "1462",
"country": "United States",
"nationalities": [
"US",
"GB"
],
"languages": [
"ENG"
],
"timezone": "Europe/Kyiv",
"id": 123,
"salutation": "Mr.",
"title": "Manager",
"employer": "Amazon",
"work_email": "[email protected]",
"work_phone": "977 840-9171",
"work_address": "301 Massachusetts Ave",
"work_address_ii": "",
"work_fax": "31432",
"work_city": "Lunenburg",
"work_state": "MA",
"work_postal_code": "134",
"work_country": "United States",
"sb_id": "123",
"oa_id": "123"
}
}Success
{
"parent": {
"id": 2033,
"title": "MD",
"employer": "FEG",
"salutation": "Mr.",
"email": "[email protected]",
"first_name": "Stepan",
"last_name": "Bandera",
"archived": false,
"ui_language": "en",
"child_ids": [],
"children": [],
"nationalities": [],
"languages": []
}
}This endpoint retrieves a single parent as specified by ID. It returns personal details and the IDs of their associated students.
Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.
Unique identifier for a parent.
Success
GET /v2/parents/{id} HTTP/1.1
Host: api.devel.managebac.com
Accept: */*
Success
{
"parent": {
"id": 2029,
"email": "[email protected]",
"first_name": "Justin",
"last_name": "Henderson",
"identifier": "AA1001",
"archived": false,
"ui_language": "en",
"gender": "Male",
"timezone": "America/Lima",
"child_ids": [],
"children": [],
"street_address": "561 Center Avenue",
"city": "Solvang",
"state": "46590-9842",
"zipcode": "81834-7928",
"country": "99",
"nationalities": [],
"languages": [],
"role": "Parent"
}
}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.
Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.
Unique identifier for a parent.
Fields for update parent
Success
PATCH /v2/parents/{id} HTTP/1.1
Host: api.devel.managebac.com
Content-Type: application/json
Accept: */*
Content-Length: 860
{
"parent": {
"email": "[email protected]",
"first_name": "Richard",
"middle_name": "David",
"password": "qwerty9876",
"last_name": "Chandler",
"nickname": "Ricky",
"other_name": "",
"identifier": "AA1001",
"gender": "Male",
"birthday": "1972-10-24",
"phone_number": "977 840-2231",
"mobile_phone_number": "977 840-2231",
"street_address": "301 Massachusetts Ave",
"street_address_ii": "",
"city": "Lunenburg",
"state": "Virginia",
"zipcode": "1462",
"country": "United States",
"nationalities": [
"US",
"GB"
],
"languages": [
"ENG"
],
"timezone": "Europe/Kyiv",
"id": 123,
"salutation": "Mr.",
"title": "Manager",
"employer": "Amazon",
"work_email": "[email protected]",
"work_phone": "977 840-9171",
"work_address": "301 Massachusetts Ave",
"work_address_ii": "",
"work_fax": "31432",
"work_city": "Lunenburg",
"work_state": "MA",
"work_postal_code": "134",
"work_country": "United States",
"sb_id": "123",
"oa_id": "123"
}
}Success
{
"parent": {
"id": 2036,
"email": "[email protected]",
"first_name": "Stepan",
"last_name": "Bandera",
"archived": false,
"ui_language": "en",
"gender": "Male",
"timezone": "America/Indiana/Knox",
"child_ids": [],
"children": [],
"street_address": "49702 Melrose Junction",
"city": "El Cajon",
"state": "59637",
"zipcode": "64840-0647",
"country": "BA",
"nationalities": [],
"languages": []
}
}This endpoint archives a parent record as specified by ID. This effectively removes the parent from groups they are members of.
Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.
Unique identifier for a parent.
Success
PUT /v2/parents/{id}/archive HTTP/1.1
Host: api.devel.managebac.com
Accept: */*
Success
{
"status": "ok"
}This endpoint reverses the archive operation on the parent record as specified by ID. This effectively restores the parent’s group memberships.
Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.
Unique identifier for a parent.
Success
PUT /v2/parents/{id}/unarchive HTTP/1.1
Host: api.devel.managebac.com
Accept: */*
Success
{
"status": "ok"
}Last updated
Was this helpful?