Get an entity

GET

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

GET

/app/api/v1/entity/:id

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

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "id": 91,
6     "name": "Rivera Family Foundation",
7     "legal_name": "Rivera Family Foundation Inc.",
8     "tax_id": "11-2345678",
9     "tax_exempt": true,
10     "email": "finance@riverafoundation.org",
11     "phone": "+1-212-555-0160",
12     "note": "Annual scholarship sponsor",
13     "type": {
14       "id": 4,
15       "name": "Donor",
16       "description": "Individual or organization donor"
17     },
18     "addresses": [],
19     "total_paid": 12500,
20     "total_fees": 15000,
21     "total_due_today": 2500,
22     "donation_receipt_not_allowed": false,
23     "processing_fee_blocked": false,
24     "is_processing_fee_blocked": false
25   }
26 }

Retrieves one school entity with its type, addresses, and fee totals.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired

Entity ID.

Response

Entity details.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error