---
updatedAt: 2026-05-27T07:01:03.000Z
agentTools:
projectIndex: https://open-api.docs.shoplineapp.com/llms.txt
---
# Get all staff
To retrieve all staff
獲取所有管理員。
# OpenAPI definition
```json
{
"info": {
"title": "SHOPLINE Open API",
"version": "2.348.2",
"description": "Welcome to the shopline open-api developer hub. You'll find comprehensive guides and documentation to help you start working with shopline open-api as quickly as possible, as well as support if you get stuck. Let's jump right in!"
},
"servers": [
{
"url": "https://open.shopline.io/v1",
"description": "Production"
}
],
"openapi": "3.0.0",
"security": [
{
"bearerAuth": []
}
],
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
},
"schemas": {
"Channel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "5ce0d084e388096bdb229a59"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/Translatable"
},
{
"description": "Name Translations
名稱"
}
]
},
"platform": {
"description": "Shopee
\nshop_crm
\nonline
\npos
\nsc",
"type": "string",
"enum": [
"Shopee",
"shop_crm",
"online",
"pos",
"sc"
]
},
"merchant_id": {
"type": "string"
},
"updated_at": {
"type": "string",
"example": "2018-07-31T03:57:36.409+00:00"
},
"created_at": {
"type": "string",
"example": "2018-07-31T03:57:36.409+00:00"
},
"currency_code": {
"type": "string"
},
"merchant_name": {
"type": "string"
},
"default_warehouse_id": {
"type": "string",
"example": "5ce0d084e388096bdb229a59"
},
"identifier": {
"type": "string",
"example": "00222333"
},
"phones": {
"type": "object",
"properties": {
"main": {
"type": "string",
"example": "0912345678"
}
}
},
"address": {
"type": "object",
"example": {
"address_1": "1/F, Some Building",
"city": "City",
"state": "Perak",
"postcode": "36500",
"country": "Malaysia",
"country_code": "MY"
}
},
"pin_codes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": ""
},
"scope": {
"type": "string",
"example": "switch_store"
}
}
}
},
"mobile_logo_media_url": {
"type": "string"
},
"e_invoice_setting": {
"type": "object",
"description": "only expose this object when the request_params include_fields contains e_invoice_setting value and the merchant of the channel has sl_pos_one_einvoice_setting rollout_key",
"properties": {
"invoice_type": {
"type": "string",
"description": "invoice setting type",
"enum": [
"none",
"tradevan",
"cetustek"
],
"example": "none"
},
"invoice": {
"type": "object",
"description": "only show this object when invoice_type is cetustek",
"properties": {
"tax_id": {
"type": "string",
"description": "發票統一編號"
},
"source": {
"type": "object",
"description": "merchant invoice information",
"properties": {
"business_entity": {
"type": "string",
"description": "營業人名稱"
}
}
}
}
},
"invoice_tradevan": {
"type": "object",
"description": "only show this object when invoice_type is tradevan",
"properties": {
"tax_id": {
"type": "string",
"description": "發票統一編號"
},
"source": {
"type": "object",
"description": "merchant invoice information",
"properties": {
"business_entity": {
"type": "string",
"description": "營業人名稱"
},
"business_type_code": {
"type": "string",
"description": "事業別代號"
}
}
}
}
}
}
}
}
},
"Merchant": {
"type": "object",
"properties": {
"id": {
"description": "Merchant ID
商户ID",
"type": "string",
"example": "5e8c5b7a2c389a006ad21050"
},
"base_country_code": {
"description": "Country/Region code
國家/地區代碼",
"type": "string",
"example": "TW"
},
"base_currency_code": {
"description": "Currency code
貨幣代碼",
"type": "string",
"example": "TWD"
},
"name": {
"description": "Shop Name
商店名稱",
"type": "string",
"example": "vicky's store 志龍"
},
"email": {
"description": "Shop Email
商店電郵",
"type": "string",
"example": "vicky@shopline.com"
},
"handle": {
"description": "Shop code
商店代碼",
"type": "string",
"example": "vickyvickyvicky"
},
"custom_domain": {
"description": "Shop custom domain
商店自訂網域",
"type": "string",
"example": "www.vickyvickyvicky.com"
},
"current_plan_key": {
"description": "Shop plan key
商店計劃代碼",
"type": "string",
"example": "premium_3year"
},
"default_language_code": {
"description": "Default language code
默認語言代碼",
"type": "string",
"example": "en"
},
"staff_id": {
"description": "Staff ID
管理員ID",
"type": "string",
"example": "5b55ae85b818790005cc40c1"
},
"rollout_keys": {
"description": "Supported function keys
支援的功能代碼",
"type": "array",
"items": {
"type": "string"
},
"example": [
"admin_v2",
"studio_livestream",
"channel_customer_authentication"
]
},
"supported_languages": {
"description": "Supported languages
支援的語言",
"type": "array",
"items": {
"type": "string"
},
"example": [
"en",
"zh-hant",
"ja",
"id",
"ms",
"zh-cn",
"fr",
"de",
"th",
"vi"
]
},
"logo_media": {
"allOf": [
{
"$ref": "#/components/schemas/Media"
},
{
"description": "Logo Media Data
Logo媒體(照片)資訊"
}
]
},
"kyc_status": {
"description": "KYC status
KYC審核狀態",
"type": "string",
"enum": [
"not_yet_applied",
"basic_account_pending",
"basic_account_verified",
"basic_account_rejected",
"basic_account_reviewed",
"advanced_account_pending",
"advanced_account_verified",
"advanced_account_rejected",
"advanced_account_failed"
],
"example": "not_yet_applied"
},
"admin_status": {
"description": "Admin status",
"type": "string",
"enum": [
"normal",
"suspended"
],
"example": "normal"
},
"sl_payment_merchant_id": {
"description": "sl_payment_merchant_id
支付中台merchant id",
"type": "string"
},
"sl_payment_mcc": {
"description": "sl_payment_mcc
渠道分配的mcc",
"type": "string"
},
"sl_payment_billing_descriptor_name": {
"description": "Store's billing descriptor
商店交易名稱",
"type": "string"
},
"product_lines": {
"description": "Product Lines
商戶訂閱",
"type": "object"
},
"tags": {
"description": "tags
標籤",
"type": "array",
"items": {
"type": "string"
}
},
"emails": {
"description": "emails
其他電郵",
"type": "object"
},
"phones": {
"description": "phones
電話",
"type": "object"
},
"pos_payment_id": {
"description": "POS payment id",
"type": "string"
},
"pos_delivery_option_id": {
"description": "POS Delivery option id",
"type": "string"
},
"brand_home_url": {
"description": "Storefront url
店鋪地址",
"type": "string",
"example": "https://handle.shoplineapp.com"
},
"taxes": {
"description": "Tax Info of Merchant
商店稅金設定",
"type": "array",
"items": {
"$ref": "#/components/schemas/MerchantTax"
}
},
"current_theme_key": {
"description": "The theme key that the merchant is currently
商家當前正在使用的主題
Only provided when include_fields contains 'current_theme_key'
僅於include_fields傳入 'current_theme_key' 時提供",
"type": "string",
"example": "ultra_chic"
},
"instagram_username": {
"description": "The instagram username of the merchant linked currently
商家當前正在連結的Instagram用戶名稱
Only provided when include_fields contains 'instagram_username'
僅於include_fields傳入 'instagram_username' 時提供",
"type": "string",
"example": "freecodecamp"
},
"whitelisted_ip_addresses": {
"description": "The whitelisted IP addresses
登入 IP 位置白名單
Presented in GET /merchants/:merchant_id, but not in GET /merchants
會於 GET /merchants/:merchant_id，但不於 GET /merchants 出現",
"type": "array",
"items": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"example": "6360953220b56c0034befa35"
},
"name": {
"type": "string",
"example": "my IP"
},
"address": {
"type": "string",
"example": "127.0.0.1"
},
"updated_at": {
"type": "string",
"example": "2022-11-01T03:40:34.382Z"
},
"created_at": {
"type": "string",
"example": "2022-11-01T03:40:34.382Z"
}
}
}
}
}
},
"Staff": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID",
"example": "5f8e5dc08a8bb70a5c9cd93c"
},
"email": {
"type": "string",
"description": "Email
電郵"
},
"name": {
"type": "string",
"description": "Name
員工名稱"
},
"locale_code": {
"type": "string",
"description": "Locale of staff using
員工語系"
},
"owned_merchants": {
"type": "array",
"description": "Associated merchants this staff owns
帳號為店長的店鋪",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Merchant ID"
},
"name": {
"type": "string",
"description": "Merchant name"
},
"handle": {
"type": "string",
"description": "Merchant handle"
},
"base_country_code": {
"type": "string",
"description": "Merchant country code"
},
"custom_domain": {
"type": "string",
"description": "Merchant custom domain"
}
}
}
},
"employed_merchants": {
"type": "array",
"description": "Associated merchants this staff belongs to
帳號服務的店鋪",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Merchant ID"
},
"name": {
"type": "string",
"description": "Merchant name"
},
"handle": {
"type": "string",
"description": "Merchant handle"
},
"base_country_code": {
"type": "string",
"description": "Merchant country code"
},
"custom_domain": {
"type": "string",
"description": "Merchant custom domain"
}
}
}
},
"user_id": {
"type": "string",
"description": "user ID
使用者 ID",
"nullable": true,
"example": "5f8e5dc08a8bb70a5c9cd93b"
},
"created_at": {
"type": "string",
"description": "Created Time
創建時間",
"example": "2018-05-15T09:09:04.497Z"
},
"merchant_ids": {
"type": "array",
"description": "Associated merchant IDs this staff belongs to
帳號服務的店鋪 ID",
"items": {
"type": "string",
"description": "merchant ID
店鋪 ID",
"example": "5afaa3b0e38809312d00002e"
}
},
"organization_ids": {
"type": "array",
"description": "Associated organization IDs this staff belongs to
帳號服務的組織 ID",
"items": {
"type": "string",
"description": "organization ID
組織 ID",
"example": "5afaa3b0e38809312d00002e"
}
},
"role_keys": {
"type": "array",
"items": {
"type": "string"
}
},
"profile_image_url": {
"type": "string",
"description": "Profile image url
個人資料相片URL",
"example": "https://shoplineimg.com/assets/misc/placeholder-user-default.png"
},
"channel_ids": {
"description": "Channel IDs
頻道 IDs",
"type": "array",
"items": {
"type": "string",
"description": "Channel ID
頻道 ID",
"example": "606ed59eb230660044e8ef7a"
}
}
}
}
}
},
"paths": {
"/staffs": {
"get": {
"summary": "Get all staff",
"description": "To retrieve all staff
獲取所有管理員。",
"parameters": [
{
"name": "permission_scopes",
"description": "The permissions scopes
獲取權限的範圍(可以多個)。",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"open_api",
"admin",
"shop_crm",
"pos",
"one",
"shoplytics",
"sc",
"dash",
"ads",
"payment_center",
"mc",
"form_builder"
],
"example": "admin"
}
}
}
],
"tags": [
"Staffs"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"description": "Staffs array
管理員array",
"type": "array",
"items": {
"description": "Staff
管理員",
"type": "object",
"properties": {
"id": {
"oneOf": [
{
"$ref": "#/components/schemas/Staff/properties/id"
}
]
},
"_id": {
"oneOf": [
{
"$ref": "#/components/schemas/Staff/properties/id"
}
]
},
"user_id": {
"type": "string"
},
"created_at": {
"type": "string",
"example": "2021-09-29T02:42:09.993Z"
},
"merchant_ids": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Merchant/properties/id"
}
]
}
},
"organization_ids": {
"description": "Currently this field return null
目前此欄返回null值。",
"type": "string"
},
"email": {
"oneOf": [
{
"$ref": "#/components/schemas/Staff/properties/email"
}
]
},
"name": {
"oneOf": [
{
"$ref": "#/components/schemas/Staff/properties/name"
}
]
},
"locale_code": {
"oneOf": [
{
"$ref": "#/components/schemas/Staff/properties/locale_code"
}
]
},
"role_keys": {
"type": "array",
"items": {
"type": "string"
}
},
"profile_image_url": {
"description": "Profile image url
個人資料相片URL",
"type": "string",
"example": "https://shoplineimg.com/assets/misc/placeholder-user-default.png"
},
"owned_merchants": {
"oneOf": [
{
"$ref": "#/components/schemas/Staff/properties/owned_merchants"
}
]
},
"employed_merchants": {
"oneOf": [
{
"$ref": "#/components/schemas/Staff/properties/employed_merchants"
}
]
},
"channel_ids": {
"description": "Channel ids
頻道ids。",
"type": "array",
"items": {
"type": "string"
}
},
"permissions": {
"description": "Permissions array
權限array
if permission_scopes is not provided, this field will return null.
如果沒有permission_scopes，返回null。",
"type": "array",
"items": {
"description": "Permission
權限",
"type": "object",
"properties": {
"id": {
"description": "Permission id
權限id",
"type": "string",
"example": "61b1d564065f7e0007dcf5a7"
},
"has_full_access": {
"type": "boolean"
},
"channel_id": {
"$ref": "#/components/schemas/Channel/properties/id"
},
"status": {
"type": "string",
"enum": [
"active",
"removed"
]
},
"grants": {
"type": "object",
"example": {
"all": [
"all"
]
}
},
"scope": {
"type": "string",
"enum": [
"open_api",
"admin",
"shop_crm",
"pos",
"one",
"shoplytics",
"sc",
"dash",
"ads",
"payment_center",
"mc",
"form_builder"
],
"example": "admin"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
```