---
title: "Get Agents"
method: GET
path: "/agents"
tags: ["Agents"]
---

# Get Agents

`GET /agents`

## Request

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

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

## Query parameters

- `page` integer
- `per_page` integer
- `sort_by` 'asc' | 'desc'
- `excludes[]` string[]
- `fields[]` string[]
- `channel_ids[]` string[]

## Response `200`

OK

- object
  - `items` Agent[]
    - `id` string: Id of the agent<br>員工ID
    - `email` string: Email of the agent<br>員工電郵
    - `name` string: Name of the agent<br>員工名稱
    - `phone` string: Phone of the agent<br>員工電話號碼
    - `is_working` boolean: Working status of the agent<br>員工工作狀態（上班/下班）
    - `channel_ids` unknown[]: Staff's store IDs<br>員工所有的門市
      - unknown
  - `pagination` Paginatable
    - `current_page` integer: The current page number<br>當前分頁
    - `per_page` integer: Number of result per page<br>每頁顯示 n 筆資料<br>(Default: 24)
    - `total_count` integer: Number of result in total<br>資料總量
    - `total_pages` integer: Number of pages in total<br>總頁數量

## Changes

- **2026-11-03** `d2518391b149`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/shoplineapp/apis/shopline-open-api/changes/agents/get.md)

---

[API](https://skmtc.dev/shoplineapp/apis/shopline-open-api.md) - [All operations](https://skmtc.dev/shoplineapp/apis/shopline-open-api/llms.txt) - [OpenAPI document](https://skmtc.dev/shoplineapp/apis/shopline-open-api/revisions/d2518391b149?raw)