Parents

Parents are users who are adults connected to students

Get all Parents

get

/v2p0/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

200

Success

application/json

get

/v2p0/parents

GET /v2p0/parents HTTP/1.1
Host: api.devel.managebac.com
Accept: */*

200

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
  }
}

Create New Parent

post

/v2p0/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

Responses

201

Success

application/json

post

/v2p0/parents

POST /v2p0/parents HTTP/1.1
Host: api.devel.managebac.com
Content-Type: application/json
Accept: */*
Content-Length: 892

{
  "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",
    "child_ids": [
      10193652,
      11124234
    ]
  }
}

201

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": []
  }
}

Get a Parent

get

/v2p0/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

200

Success

application/json

get

/v2p0/parents/{id}

GET /v2p0/parents/{id} HTTP/1.1
Host: api.devel.managebac.com
Accept: */*

200

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"
  }
}

Update a Parent

patch

/v2p0/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

Responses

200

Success

application/json

patch

/v2p0/parents/{id}

PATCH /v2p0/parents/{id} HTTP/1.1
Host: api.devel.managebac.com
Content-Type: application/json
Accept: */*
Content-Length: 892

{
  "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",
    "child_ids": [
      10193652,
      11124234
    ]
  }
}

200

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": []
  }
}

Archive a Parent

put

/v2p0/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

200

Success

application/json

put

/v2p0/parents/{id}/archive

PUT /v2p0/parents/{id}/archive HTTP/1.1
Host: api.devel.managebac.com
Accept: */*

200

Success

{
  "status": "ok"
}

Unarchive a Parent

put

/v2p0/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

200

Success

application/json

put

/v2p0/parents/{id}/unarchive

PUT /v2p0/parents/{id}/unarchive HTTP/1.1
Host: api.devel.managebac.com
Accept: */*

200

Success

{
  "status": "ok"
}

PreviousTeachers NextRelationships

Last updated 4 days ago

Was this helpful?