公司

此 API 為 2022-12-28 後版本開放。

搜尋

GET https://{API_DOMAIN}/api/v1/company

curl -X GET
    -H "Content-Type: application/json"
    '{"name": "vip"}'
    https://{API_HOST}/api/v1/company

Form Data

下表為可使用的過濾條件

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
search	false	NULL	String	模糊搜尋公司名稱、編號、網域
name	false	NULL	String	搜尋公司名稱
sn	false	NULL	String	搜尋編號

Response

PROPERTY	TYPE	DESCRIPTION
data	Array of objects	公司資料陣列
meta	Object	頁籤資料

{
    "data": [
      {
        "id": 1,
        "name": "FIRST LINE",
        "sn": '50889516',
        "domains": [
          "https://www.firstline.cc/"
        ],
        "contacts_count": 1,
        "description": null,
        "creater_id": 1,
        "creater": {...}
      }
    ],
    "links": {...},
    "meta": {...}
}

取得單筆資料

GET https://{API_DOMAIN}/api/v1/company/{{ company }}

curl -X GET
    -H "Content-Type: application/json"
    https://{API_HOST}/api/v1/company/1

URL Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
id	true	NULL	Number	客戶標籤系統 ID

Response

PROPERTY	TYPE	DESCRIPTION
data	Object	公司資料

{
    "data": {
      "id": 1,
      "name": "FIRST LINE",
      "sn": '50889516',
      "domains": [
        "https://www.firstline.cc/"
      ],
      "contacts_count": 1,
      "description": null,
      "creater_id": 1,
      "creater": {...}
    }
}

新增

POST https://{API_DOMAIN}/api/v1/company

    '{"name": "FIRST LINE", "description": "企業級客服系統" }'
    https://{API_HOST}/api/v1/company

Form Data

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
name	true	NULL	String	名稱
description	false	NULL	String	描述
sn	false	NULL	String	統一編號
domains	fale	Null	Array	企業網域

Response

{
    "data": {
      "id": 1,
      "name": "FIRST LINE",
      "sn": '50889516',
      "domains": [
        "https://www.firstline.cc/"
      ],
      "contacts_count": 1,
      "description": null,
      "creater_id": 1,
      "creater": {...}
    }
}

更新

PUT https://{API_DOMAIN}/api/v1/company/{{ company }}

curl -X PUT
    -H "Content-Type: application/json"
    '{"name": "Acquire Tech" }'
    https://{API_HOST}/api/v1/company/1

URL Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
name	true	NULL	String	名稱
description	false	NULL	String	描述
sn	false	NULL	String	統一編號
domains	fale	Null	Array	企業網域

Response

{
    "data": {
      "id": 1,
      "name": "FIRST LINE",
      "sn": '50889516',
      "domains": [
        "https://www.firstline.cc/"
      ],
      "contacts_count": 1,
      "description": null,
      "creater_id": 1,
      "creater": {...}
    }
}