Get a family profile

GET

https://ssuccessv2.com/app/api/v1/family/:id

GET

/app/api/v1/family/:id

$ curl https://ssuccessv2.com/app/api/v1/family/1842 \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "id": 1842,
6     "name": "Garcia Family",
7     "addresses": [
8       {
9         "id": 550,
10         "formatted": "14 Maple Street, Brooklyn, NY 11201"
11       }
12     ],
13     "parents": [
14       {
15         "id": 4401,
16         "full_name": "Elena Garcia"
17       }
18     ],
19     "students": [
20       {
21         "id": 2987,
22         "firstname": "Mateo",
23         "lastname": "Garcia"
24       }
25     ],
26     "relatives": [],
27     "emergency_contacts": [],
28     "lastname": "Garcia",
29     "lastname_hebrew": null,
30     "home_phone": "+1-212-555-0138",
31     "cell_phone": "+1-917-555-0182",
32     "email": "family.garcia@example.com",
33     "description": null,
34     "processing_fee_blocked": false,
35     "is_processing_fee_blocked": false,
36     "statement_account_balance": 1250,
37     "statement_account_due": 325
38   }
39 }

Returns the family profile together with its parents, students, relatives, emergency contacts, and addresses.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idintegerRequired>=1

Response

Family profile.

statusstring

messagestring

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error