API Reference

GET Corporate/Company Employees (list)

URL: {{base_url}}/corporates/{{corporate_client_id}}/employees
Method: GET

Query Params to filter by:

  • mobile
  • email
  • staff_id
  • managing_organization
  • department
  • occupational_role
{
    "success": true,
    "message": "Operation successful",
    "meta": {
        "current": 1,
        "page_size_query": "page_size",
        "next": null,
        "previous": null,
        "page_size": 50,
        "total": 1
    },
    "results": [
        {
            "uuid": "19cd8fec-739c-4600-b418-9f05cdf63a08",
            "first_name": "John",
            "last_name": "Doe",
            "other_names": "None",
            "companyId": "951ce6e6-abf8-4cd1-9986-36505a512b7e",
            "occupational_role": "developer",
            "employee_tags": "RTERE",
            "gender": "MALE",
            "maximum_dependents_allowed": 3,
            "address": "15 broadway",
            "date_of_birth": "1972-01-01",
            "email": "[email protected]",
            "mobile": "+250720022717",
            "department": "",
            "credit_amount": 0.0,
            "health_programme_detail": null,
            "patientId": 14528,
            "userId": "9b2b12bd-129b-40d7-acf6-21283912005b",
            "health_policy": null,
            "contribution_type": "COPAY",
            "contribution_value": "0.00",
            "contribution_currency": "GHS",
            "out_of_pocket_limit_amount": "0.00",
            "out_of_pocket_limit_currency": "GHS",
            "deductible_amount": "0.00",
            "deductible_currency": "GHS",
            "annual_limit_amount": "0.00",
            "annual_limit_currency": "GHS",
            "card_no": null,
            "policy_holder": null,
            "beneficiaries": [
                {
                    "id": 14689,
                    "uuid": "48d9705f-c2d8-4f81-b928-ff2d32125412",
                    "account": 14658,
                    "patient": 14528,
                    "mr_number": "492d8645-8201-4dfd-b301-53925bb6301e",
                    "mobile": "+250720022717",
                    "email": "[email protected]",
                    "relationship": "SELF",
                    "is_active": true,
                    "first_name": "John",
                    "last_name": "Doe",
                    "other_names": null,
                    "policy_name": null,
                    "contribution_type": "COPAY",
                    "managing_organization": "951ce6e6-abf8-4cd1-9986-36505a512b7e",
                    "out_of_pocket_limit_currency": "GHS",
                    "contribution_value": "0.00",
                    "contribution_currency": "GHS",
                    "birth_date": "1972-01-01",
                    "card_no": null,
                    "policy_holder": null,
                    "period_start": null,
                    "period_end": null,
                    "gender": "MALE"
                }
            ],
            "is_active": true
        }
    ]
}