> For the complete documentation index, see [llms.txt](https://shiply-integration-apis.gitbook.io/shiply-integration-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://shiply-integration-apis.gitbook.io/shiply-integration-documentation/integration-apis/premium-customers/get-all-employees.md).

# Get All Employees

```php
GET /premium-customer/employees
```

This API is used to retrieve a list of all employees associated with the premium customer.

#### Headers

<table><thead><tr><th width="374">Key</th><th>Value</th></tr></thead><tbody><tr><td>Accept</td><td>application/json</td></tr></tbody></table>

#### Request body

Request parameters:

<table><thead><tr><th width="138">Field Name</th><th width="112">Required</th><th width="78">Type</th><th>Notes</th></tr></thead><tbody><tr><td>type</td><td>no</td><td>string</td><td>The value can be either "employee" or "sales" to retrieve employees of the selected type. </td></tr></tbody></table>

Request body example:

{% code lineNumbers="true" %}

```json
{
    "type": "sales",
    "Shiply_API_KEY": "your_api_key"
}
```

{% endcode %}

#### Response body

{% tabs %}
{% tab title="Success" %}
Status code: <mark style="color:green;">200 OK</mark>

{% code lineNumbers="true" %}

```json
[
    {
        "id": 7193,
        "first_name": "موظف مبيعات",
        "user_type_id": 10,
        "role_id": null,
        "second_name": "",
        "last_name": "",
        "email": "test@test.com",
        "email_verified_at": null,
        "phone_number": "0599222222",
        "phone_number_2": null,
        "landline_number": null,
        "account_status_id": 1,
        "created_at": "2024-12-12 00:35:48",
        "updated_at": "2024-12-12 00:35:48",
        "identity": null,
        "deleted_at": null,
        "start_work_at": "",
        "end_work_at": "",
        "private_note": null,
        "last_parcel_created_date": null,
        "profile_picture": null,
        "profile_picture_id": null,
        "app_id": null,
        "payment_account_enabled": 0,
        "wallet_enabled": 0,
        "can_borrow": 0,
        "customer_contacts": [],
        "pivot": {
            "leader_user_id": 4,
            "user_id": 7193
        },
        "customer_info": {
            "customer_user_id": 7193,
            "customer_code": "1jr2",
            "business_name": "business",
            "customer_number": "6579",
            "event_webhook_url": "url",
            "delivered_parcel_cost": 20,
            "returned_parcel_cost": 10,
            "al_quds_delivered_parcel_cost": 35,
            "al_quds_returned_parcel_cost": 10,
            "occupied_lands_delivered_parcel_cost": 75,
            "occupied_lands_returned_parcel_cost": 10,
            "max_balance": 2000,
            "invoice_creation_limit": 705,
            "price_extra_fee_threshold": 3000,
            "price_extra_fee_percentage": 0.01,
            "price_extra_fee_percentage_returned": 0.005,
            "url": null,
            "fixed_commission_value": 44,
            "percent_commission_value": 33,
            "show_driver_phone": 1,
            "include_parcel_after_deliver_time": 30,
            "max_companions": 2,
            "extra_size_factor": 1,
            "default_parcel_length": 43,
            "default_parcel_width": 43,
            "default_parcel_height": 43,
            "customer_classification_id": null,
            "customer_success_manager": null,
            "max_price_for_parcel": 4000,
            "is_receive_returns_from_office": 0,
            "cell": null,
            "is_product_catalog_enabled": 1,
            "move_invoices_to_wallet": 0,
            "parcel_creation_mode_id": 1,
            "has_active_promotions": false,
            "permissions": [
                {
                    "id": 8,
                    "name": "ADD_EDIT_PARCELS",
                    "display_name": "Add/Edit parcels",
                    "used_by": [
                        9,
                        10
                    ],
                    "description": "",
                    "created_at": "2023-03-02 06:22:39",
                    "updated_at": "2023-03-02 06:22:39",
                    "pivot": {
                        "customer_user_id": 7193,
                        "permission_id": 8
                    }
                },
                {
                    "id": 10,
                    "name": "ADD_REPLACE_QR",
                    "display_name": "Add/replace QR",
                    "used_by": [
                        9,
                        10
                    ],
                    "description": "",
                    "created_at": "2023-03-02 06:22:39",
                    "updated_at": "2023-03-02 06:22:39",
                    "pivot": {
                        "customer_user_id": 7193,
                        "permission_id": 10
                    }
                },
                {
                    "id": 12,
                    "name": "DOWNLOAD_EXCEL",
                    "display_name": "Download excel",
                    "used_by": [
                        9,
                        10
                    ],
                    "description": "",
                    "created_at": "2023-03-02 06:22:39",
                    "updated_at": "2023-03-02 06:22:39",
                    "pivot": {
                        "customer_user_id": 7193,
                        "permission_id": 12
                    }
                }
            ]
        },
        "addresses": []
    }
]
```

{% endcode %}

The response includes an array of employees, along with their detailed information.
{% endtab %}

{% tab title="Unauthorized access" %}
Status code: <mark style="color:green;">200 OK</mark>

{% code lineNumbers="true" %}

```json
{
    "success": false,
    "errors": [
        "unauthorized"
    ]
}
```

{% endcode %}

This response is returned when the user is not a premium customer.
{% endtab %}

{% tab title="Unauthorized" %}
Status code: <mark style="color:green;">200 OK</mark>

{% code lineNumbers="true" %}

```json
{
    "success": false,
    "errors": [
        "unauthorized"
    ]
}
```

{% endcode %}

This response is returned when the <mark style="color:blue;">Shiply\_API\_KEY</mark> is not included in the request body.
{% endtab %}
{% endtabs %}