Get Staff List

Function

To get all staffs
獲取員工列表

URL

GET <<api_domain>>/v1/staffs

Request Parameters

Parameter	Type	Description	Example
page	`Integer`	Page Number 頁數 (Default: 1)	page=1
per_page	`Integer`	Numbers of Orders per Page 每頁顯示 n 筆資料 (Default: 24)	per_page=20
permission_scopes	`Array`		Example: permission_scopes[]=mc

Response Fields

Field	Type	Description	Example
items	Get Staff	Staff Information 員工資訊	Please check the link on the left
pagination	Pagination	Pagination 頁面資訊	Please check the link on the left

Response Example

{
    "items": [
        {
            "id": "5b728d18e388094d52cf28a2",
            "_id": "5b728d18e388094d52cf28a2",
            "user_id": "5afaa3b0d2a93e03a1000020",
            "created_at": "2018-05-15T09:09:04.497Z",
            "merchant_ids": [
                "5afaa3b0e38809312d00002e"
            ],
            "organization_ids": [],
            "email": "[email protected]",
            "name": "shopline",
            "locale_code": "zh-hant",
            "role_keys": [],
            "profile_image_url": "https://shoplineimg.com/assets/misc/placeholder-user-default.png",
            "owned_merchants": [
                {
                    "_id": "5afaa3b0e38809312d00002e",
                    "name": "shopline",
                    "handle": "shopline",
                    "logo_media_id": "637475f5e03d430036032bbb",
                    "base_country_code": "TW",
                    "custom_domain": ""
                }
            ],
            "employed_merchants": [
                {
                    "_id": "5afa5eabe38809312d000006",
                    "name": "shopline",
                    "handle": "shopline",
                    "logo_media_id": null,
                    "base_country_code": "TW",
                    "custom_domain": null
                }
            ],
            "channel_ids": [
                "606ed59eb230660044e8ef7a"
            ],
            "permissions": null
        }
    ],
    "pagination": {
        "current_page": 1,
        "per_page": 1,
        "total_pages": 1,
        "total_count": 1
    }
}