Get Agents
Get Agents
Endpoint
GET <<api_domain>>/v1/agents
Request Params
Field | Type | Description | Example |
---|---|---|---|
merchant_id | BSON::ObjectId | merchant_id='58c1362e01cda33293000048' | |
fields | Array | Only return the required fields | fields=["items.id", "items.name", "items.email", "items.phone", "items.is_working"] |
per_page | Integer | Numbers of Orders per Page 每頁顯示 n 筆資料 (Default: 24) | per_page=20 |
page | Integer | Page Number 頁數 (Default: 1) | page=1 |
Headers
Field | Type | Description | Example |
---|---|---|---|
Authorization | String | Bearer authentication with access token given | Required: 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
}
}
Updated about 1 month ago