HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

[Coming Soon] Get Agents

(We will release this API soon!)

Get Agents

Endpoint

GET https://open.shoplineapp.com/v1/agents

Request Params

FieldTypeDescriptionExample
merchant_idBSON::ObjectIdmerchant_id='58c1362e01cda33293000048'
fieldsArrayOnly return the required fieldsfields=["items.id", "items.name", "items.email", "items.phone", "items.is_working"]
per_pageIntegerNumbers of Orders per Page
每頁顯示 n 筆資料
(Default: 24)
per_page=20
pageIntegerPage Number
頁數
(Default: 1)
page=1

Headers

FieldTypeDescriptionExample
AuthorizationStringBearer authentication with access token givenRequired: true

Response


{
  "items": [
    {
      "id": "5f19669fe388097422644d0d",
      "name": "peter",
      "email": null,
      "phone": null,
      "is_working": true
    },
    {
      "id": "5f195c46e388090bb3461bfc",
      "name": "hi",
      "email": null,
      "phone": null,
      "is_working": false
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_pages": 1,
    "total_count": 2
  }
}