API Live Demos

Selected Example: list-employees

Back to examples list

Request Information:

Method: GET
URL: /employees
Query Parameters:
pageSize: 5
Headers:
Authorization: Bearer ***
Accept: application/json
Content-Type: application/json

API Response:

{
    "data": [
        {
            "employee_id": 65015,
            "shop_id": "6062",
            "first_name": "JOHN",
            "last_name": "SMITH",
            "address": "",
            "city": "",
            "state": "",
            "zip": "",
            "phone": "1112223333",
            "email": "john.smith@example.com",
            "emergency_contact": "",
            "emergency_phone": "",
            "job_description": "OWNER",
            "hourly_rate": 0,
            "mode": "Full",
            "mechanic_number": "",
            "payment_type": "HOURLY",
            "commission": 0,
            "theme": 0,
            "photo": "employee_photo_1.jpg",
            "date_hired": "2020-03-02T00:00:00.000000Z",
            "timestamp": "2019-09-09T22:05:05.000000Z",
            "updated_at": "2025-08-01 14:59:21",
            "permissions": {
                "login_shopboss_pro": "YES",
                "settings_access": "yes",
                "report_access": "yes",
                "accounting_access": "yes",
                "integrations_access": "yes",
                "boos_board_access": "yes",
                "create_repair_order": "yes",
                "show_gp_in_repair_order": "no",
                "edit_comments_in_repair_order": "no",
                "edit_tech_paid_log_in_repair_order": "no",
                "change_repair_order_status": "yes",
                "reopen_repair_order": "yes",
                "change_repair_order_dates": "yes",
                "delete_labor_and_parts_from_repair_order": "yes",
                "add_edit_employees": "yes",
                "create_part_sale": "yes",
                "edit_supplier": "yes",
                "inventory_lookup": "yes",
                "change_shop_notice": "yes",
                "download_data": "yes",
                "order_parts_online": "yes",
                "edit_inventory": "YES",
                "change_parts_matrix": "yes",
                "change_parts_codes": "yes",
                "change_job_descriptions": "yes",
                "change_advertising_sources": "yes",
                "change_repair_order_types": "YES",
                "send_updates_to_customer": "yes",
                "delete_payments": "YES",
                "delete_customer": "yes",
                "edit_notifications": "yes"
            }
        },
        {
            "employee_id": 71956,
            "shop_id": "6062",
            "first_name": "JANE",
            "last_name": "DOE",
            "address": "",
            "city": "",
            "state": "",
            "zip": "",
            "phone": "2223334444",
            "email": "jane.doe@example.com",
            "emergency_contact": "",
            "emergency_phone": "",
            "job_description": "GENERAL MANAGER",
            "hourly_rate": 40,
            "mode": "Full",
            "mechanic_number": "",
            "payment_type": "FLATRATE",
            "commission": 0,
            "theme": 0,
            "photo": "",
            "date_hired": "2020-02-17T00:00:00.000000Z",
            "timestamp": "2020-02-17T16:23:24.000000Z",
            "updated_at": "2025-07-22 15:21:02",
            "permissions": {
                "login_shopboss_pro": "YES",
                "settings_access": "yes",
                "report_access": "YES",
                "accounting_access": "YES",
                "integrations_access": "yes",
                "boos_board_access": "yes",
                "create_repair_order": "YES",
                "show_gp_in_repair_order": "yes",
                "edit_comments_in_repair_order": "yes",
                "edit_tech_paid_log_in_repair_order": "yes",
                "change_repair_order_status": "yes",
                "reopen_repair_order": "YES",
                "change_repair_order_dates": "yes",
                "delete_labor_and_parts_from_repair_order": "YES",
                "add_edit_employees": "YES",
                "create_part_sale": "YES",
                "edit_supplier": "YES",
                "inventory_lookup": "YES",
                "change_shop_notice": "YES",
                "download_data": "yes",
                "order_parts_online": "yes",
                "edit_inventory": "YES",
                "change_parts_matrix": "YES",
                "change_parts_codes": "YES",
                "change_job_descriptions": "YES",
                "change_advertising_sources": "YES",
                "change_repair_order_types": "yes",
                "send_updates_to_customer": "YES",
                "delete_payments": "YES",
                "delete_customer": "YES",
                "edit_notifications": "yes"
            }
        },
        {
            "employee_id": 72900,
            "shop_id": "6062",
            "first_name": "ROBERT",
            "last_name": "JOHNSON",
            "address": "",
            "city": "",
            "state": "",
            "zip": "",
            "phone": "3334445555",
            "email": "robert.johnson@example.com",
            "emergency_contact": "",
            "emergency_phone": "",
            "job_description": "General Labor",
            "hourly_rate": 0,
            "mode": "Full",
            "mechanic_number": "",
            "payment_type": "FLATRATE",
            "commission": 0,
            "theme": 0,
            "photo": "",
            "date_hired": "2020-03-13T00:00:00.000000Z",
            "timestamp": "2020-03-12T22:48:49.000000Z",
            "updated_at": "2025-07-25 19:09:12",
            "permissions": {
                "login_shopboss_pro": "yes",
                "settings_access": "YES",
                "report_access": "YES",
                "accounting_access": "YES",
                "integrations_access": "yes",
                "boos_board_access": "yes",
                "create_repair_order": "YES",
                "show_gp_in_repair_order": "yes",
                "edit_comments_in_repair_order": "yes",
                "edit_tech_paid_log_in_repair_order": "yes",
                "change_repair_order_status": "yes",
                "reopen_repair_order": "YES",
                "change_repair_order_dates": "no",
                "delete_labor_and_parts_from_repair_order": "YES",
                "add_edit_employees": "YES",
                "create_part_sale": "YES",
                "edit_supplier": "YES",
                "inventory_lookup": "yes",
                "change_shop_notice": "YES",
                "download_data": "yes",
                "order_parts_online": "yes",
                "edit_inventory": "yes",
                "change_parts_matrix": "YES",
                "change_parts_codes": "YES",
                "change_job_descriptions": "YES",
                "change_advertising_sources": "YES",
                "change_repair_order_types": "no",
                "send_updates_to_customer": "YES",
                "delete_payments": "YES",
                "delete_customer": "YES",
                "edit_notifications": "yes"
            }
        },
        {
            "employee_id": 80473,
            "shop_id": "6062",
            "first_name": "MICHAEL",
            "last_name": "WILLIAMS",
            "address": "",
            "city": "",
            "state": "",
            "zip": "",
            "phone": "4445556666",
            "email": "michael.williams@example.com",
            "emergency_contact": "",
            "emergency_phone": "",
            "job_description": "OWNER",
            "hourly_rate": 20,
            "mode": "Full",
            "mechanic_number": "",
            "payment_type": "FLATRATE",
            "commission": 0,
            "theme": 1,
            "photo": "employee_photo_2.png",
            "date_hired": "2020-10-09T00:00:00.000000Z",
            "timestamp": "2020-10-09T20:08:14.000000Z",
            "updated_at": "2025-07-22 15:21:03",
            "permissions": {
                "login_shopboss_pro": "YES",
                "settings_access": "yes",
                "report_access": "YES",
                "accounting_access": "YES",
                "integrations_access": "yes",
                "boos_board_access": "yes",
                "create_repair_order": "YES",
                "show_gp_in_repair_order": "YES",
                "edit_comments_in_repair_order": "YES",
                "edit_tech_paid_log_in_repair_order": "yes",
                "change_repair_order_status": "yes",
                "reopen_repair_order": "YES",
                "change_repair_order_dates": "yes",
                "delete_labor_and_parts_from_repair_order": "YES",
                "add_edit_employees": "YES",
                "create_part_sale": "YES",
                "edit_supplier": "YES",
                "inventory_lookup": "yes",
                "change_shop_notice": "YES",
                "download_data": "YES",
                "order_parts_online": "yes",
                "edit_inventory": "yes",
                "change_parts_matrix": "YES",
                "change_parts_codes": "YES",
                "change_job_descriptions": "YES",
                "change_advertising_sources": "YES",
                "change_repair_order_types": "no",
                "send_updates_to_customer": "YES",
                "delete_payments": "YES",
                "delete_customer": "YES",
                "edit_notifications": "yes"
            }
        },
        {
            "employee_id": 85770,
            "shop_id": "6062",
            "first_name": "SARAH",
            "last_name": "WILSON",
            "address": "",
            "city": "",
            "state": "",
            "zip": "",
            "phone": "",
            "email": "sarah.wilson@example.com",
            "emergency_contact": "",
            "emergency_phone": "",
            "job_description": "SERVICE TECHNICIAN",
            "hourly_rate": 50,
            "mode": "Full",
            "mechanic_number": "",
            "payment_type": "FLATRATE",
            "commission": 0,
            "theme": 1,
            "photo": "",
            "date_hired": "2021-02-16T00:00:00.000000Z",
            "timestamp": "2021-02-16T16:01:40.000000Z",
            "updated_at": "2025-08-06 12:16:06",
            "permissions": {
                "login_shopboss_pro": "YES",
                "settings_access": "YES",
                "report_access": "YES",
                "accounting_access": "YES",
                "integrations_access": "yes",
                "boos_board_access": "no",
                "create_repair_order": "no",
                "show_gp_in_repair_order": "YES",
                "edit_comments_in_repair_order": "no",
                "edit_tech_paid_log_in_repair_order": "NO",
                "change_repair_order_status": "yes",
                "reopen_repair_order": "YES",
                "change_repair_order_dates": "NO",
                "delete_labor_and_parts_from_repair_order": "YES",
                "add_edit_employees": "YES",
                "create_part_sale": "YES",
                "edit_supplier": "YES",
                "inventory_lookup": "YES",
                "change_shop_notice": "YES",
                "download_data": "YES",
                "order_parts_online": "yes",
                "edit_inventory": "no",
                "change_parts_matrix": "YES",
                "change_parts_codes": "YES",
                "change_job_descriptions": "YES",
                "change_advertising_sources": "YES",
                "change_repair_order_types": "YES",
                "send_updates_to_customer": "yes",
                "delete_payments": "YES",
                "delete_customer": "YES",
                "edit_notifications": "yes"
            }
        }
    ],
    "links": {
        "first": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=1",
        "last": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=9",
        "prev": null,
        "next": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 9,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=6",
                "label": "6",
                "active": false
            },
            {
                "url": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=7",
                "label": "7",
                "active": false
            },
            {
                "url": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=8",
                "label": "8",
                "active": false
            },
            {
                "url": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=9",
                "label": "9",
                "active": false
            },
            {
                "url": "https://dev.shopboss.io/api/v1/employees?pageSize=5&page=2",
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://dev.shopboss.io/api/v1/employees",
        "per_page": 5,
        "to": 5,
        "total": 43
    }
}

API Live Demos - api-live-demos.test