SHshoplineapp
Agents

Get Agents

Changed on

To get all agents with open API<br>透過open API獲取 Agents

get/agents

Request

  • Base URL
    https://open.shopline.io/v1
  • URL
    https://open.shopline.io/v1/agents
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page Number<br>頁數

per_pageinteger

Numbers of Orders per Page<br>每頁顯示 n 筆資料

sort_by'asc' | 'desc'

Setting sorting direction<br>設定時間排序

excludes[]string[]

Could exclude certain parameters in the response<br>結果要排除哪些參數

[
  "items.id"
]
fields[]string[]

Could only show certain parameters in the response<br>結果只顯示哪些參數

[
  "items.id"
]
channel_ids[]string[]

Show agents include one of channel_ids, length limit is 10<br>結果只顯示哪些員工，長度限制10個

Response

OK

Example response

{
  "items": [
    {
      "id": "61ee85739fdc3f16a1b9aa07",
      "email": "cindy@shopline.com",
      "name": "Cindy",
      "phone": "0987654321",
      "is_working": true,
      "channel_ids": [
        "61ee85739fdc3f16a1b9aa07",
        "61ee85739fdc3f16a1b9aa08"
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_count": 1,
    "total_pages": 1
  }
}

Changes