Endpoint: {{Base URL}}/degree-levels
Method: GET
Description: Fetch all the degree levels
Response
[ { "id": 6, "name": "Advance Diploma" }, { "id": 7, "name": "Bachelor" } ] |
Endpoint: {{Base URL}}/subject-areas
Method: GET
Description: Fetch all the subject areas and its related subjects
Response
[ { "id": 1, "name": "Agriculture and Veterinary Medicine", "subjects": [ { "id": 1, "name": "Agriculture" }, { "id": 2, "name": "Farm Management" }, { "id": 3, "name": "Horticulture" }, { "id": 4, "name": "Plant and Crop Sciences" }, { "id": 5, "name": "Veterinary Medicine" }, { "id": 6, "name": "Other Agriculture and Veterinary Medicine Courses" } ] } ] |
Endpoint: {{Base URL}}/client/{client_id}/education-backgrounds
Method: POST
Description: Add an education background associated with a contact
Payload:
{ "degree_title": "Bachelor in Communication and Information" (string), "degree_level_id" :7 (degree level id | integer), "institution":"Kathmandu University" (string), "course_start":"2026-05-01" (date), "course_end":"2030-05-01" (date), "subject_area":1 (subject area id | integer), "subject_id":1 (subject id | integer), "academic_score_type":"percentage" (enum [‘percentage’, ‘gpa’]), "academic_score":"90" (integer) } |
Response
{ "degree_title": "Bachelor in Communication and Information", "institution": "Kathmandu University", "course_start": "2026-05-01", "course_end": "2030-05-01", "academic_score_type": “percentage”, "academic_score":”90”, "degree_level_id": 7, "subject_id": 1, "entity_id": 7075, "entity_type": "client", "updated_at": "2026-05-20T04:25:12.000000Z", "created_at": "2026-05-20T04:25:12.000000Z", "id": 258, "entity": { "id": 7075, "uuid": "4f69212e-ecac-4d9c-837b-1383908eecbf", "first_name": "Abhilekh", "last_name": "Singh", "email": null, "secondary_email": null, "user_id": null, "phone": null, "country_of_passport": null, "dob": null, "education_background": null, "employment_background": null, "first_point_of_contact": null, "rating": { "value": 0, "label": "-" }, "created_at": "2026-05-18T00:09:49.000000Z", "updated_at": "2026-05-18T00:09:49.000000Z", "photo": null, "street": null, "city": null, "state": null, "zip_code": null, "country": null, "assigned_to": null, "comment": null, "commented_at": null, "preferred_intake": null, "archived_on": null, "archived_by": null, "client_identifier": null, "visa_expiry_date": null, "visa_type": null, "status": { "value": 2, "label": "Lead" }, "branch_id": 2, "passport_number": null, "tag": "application-form-22222", "enquired_at": "2026-05-18", "prospected_at": null, "application_added_at": null, "portal_enabled": 0, "password": null, "remember_token": null, "phone_number_country_code": null, "gender": null, "agent_portal_client_info": null, "photo_url": null } } |
Endpoint: {{Base URL}}/client/{client_id}/education
Method: GET
Description: Fetch all the education backgrounds
{ "education_backgrounds": [ { "id": 258, "degree_title": "Bachelor in Agricultural Science", "institution": "Kathmandu University", "course_start": { "formatted": "May 2026", "actual": "2026-05-01T00:00:00+00:00" }, "course_end": { "formatted": "May 2030", "actual": "2030-05-01T00:00:00+00:00" }, "academic_score_type":”percentage”, "academic_score":”90”, "subject_area": { "id": 1, "name": "Agriculture and Veterinary Medicine" }, "subject": { "id": 1, "name": "Agriculture" }, "degree_level": { "id": 7, "name": "Bachelor" } } ], "english_test_scores": [ { "test_id": 1, "name": "TOEFL", "score": null, "bands": [ { "id": 1, "name": "Listening", "score": null }, { "id": 2, "name": "Reading", "score": null }, { "id": 3, "name": "Writing", "score": null }, { "id": 4, "name": "Speaking", "score": null } ] }, { "test_id": 2, "name": "IELTS", "score": null, "bands": [ { "id": 5, "name": "Listening", "score": null }, { "id": 6, "name": "Reading", "score": null }, { "id": 7, "name": "Writing", "score": null }, { "id": 8, "name": "Speaking", "score": null } ] }, { "test_id": 3, "name": "PTE", "score": null, "bands": [ { "id": 9, "name": "Listening", "score": null }, { "id": 10, "name": "Reading", "score": null }, { "id": 11, "name": "Writing", "score": null }, { "id": 12, "name": "Speaking", "score": null } ] }, { "test_id": 8, "name": "Duolingo", "score": null, "bands": [ { "id": 13, "name": "Literacy", "score": null }, { "id": 14, "name": "Comprehension", "score": null }, { "id": 15, "name": "Conversation", "score": null }, { "id": 16, "name": "Production", "score": null } ] } ], "other_test_scores": [ { "test_id": 4, "name": "SAT I", "score": null, "bands": [] }, { "test_id": 5, "name": "SAT II", "score": null, "bands": [] }, { "test_id": 6, "name": "GRE", "score": null, "bands": [] }, { "test_id": 7, "name": "GMAT", "score": null, "bands": [] } ] } |
