🏢Company

This API is available for versions after 2022-12-28.

Search

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

The table below shows available filter conditions

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
search	false	NULL	String	Fuzzy search company name, number, or domain
name	false	NULL	String	Search company name
sn	false	NULL	String	Search number

Response

PROPERTY	TYPE	DESCRIPTION
data	Array of objects	Array of company data
meta	Object	Pagination data

{
    "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 single record

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	Contact tag system ID

Response

PROPERTY	TYPE	DESCRIPTION
data	Object	Company data

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

Create

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

    '{"name": "FIRST LINE", "description": "Enterprise-level customer service system" }'
    https://{API_HOST}/api/v1/company

Form Data

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
name	true	NULL	String	Name
description	false	NULL	String	Description
sn	false	NULL	String	Uniform business number
domains	fale	Null	Array	Corporate domain

Response

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

Update

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	Name
description	false	NULL	String	Description
sn	false	NULL	String	Uniform business number
domains	fale	Null	Array	Corporate domain

Response

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