> For the complete documentation index, see [llms.txt](https://en.help.firstline.cc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://en.help.firstline.cc/developer/api/company.md).

# Company

{% hint style="warning" %}
 This API is available for versions after 2022-12-28.
{% endhint %}

## Search

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

```javascript
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

<table><thead><tr><th>PARAMETER</th><th>REQUIRED</th><th width="122">DEFAULT</th><th>TYPE</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td>PARAMETER</td><td>REQUIRED</td><td>DEFAULT</td><td>TYPE</td><td>DESCRIPTION</td></tr><tr><td><strong>search</strong></td><td>false</td><td>NULL</td><td>String</td><td>Fuzzy search company name, number, or domain</td></tr><tr><td><strong>name</strong></td><td>false</td><td>NULL</td><td>String</td><td>Search company name</td></tr><tr><td><strong>sn</strong></td><td>false</td><td>NULL</td><td>String</td><td>Search number</td></tr></tbody></table>

### Response

| PROPERTY | TYPE             | DESCRIPTION           |
| -------- | ---------------- | --------------------- |
| **data** | Array of objects | Array of company data |
| **meta** | Object           | Pagination data       |

```json
{
    "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

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

```javascript
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 |

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

## Create

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

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

### Form Data

<table data-header-hidden><thead><tr><th width="201">PARAMETER</th><th>REQUIRED</th><th>DEFAULT</th><th>TYPE</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td>PARAMETER</td><td>REQUIRED</td><td>DEFAULT</td><td>TYPE</td><td>DESCRIPTION</td></tr><tr><td><strong>name</strong></td><td>true</td><td>NULL</td><td>String</td><td>Name</td></tr><tr><td><strong>description</strong></td><td>false</td><td>NULL</td><td>String</td><td>Description</td></tr><tr><td><strong>sn</strong></td><td>false</td><td>NULL</td><td>String</td><td>Uniform business number</td></tr><tr><td><strong>domains</strong></td><td>fale</td><td>Null</td><td>Array</td><td>Corporate domain</td></tr></tbody></table>

### Response

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

## Update

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

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

### URL Parameters

<table data-header-hidden><thead><tr><th width="201">PARAMETER</th><th>REQUIRED</th><th>DEFAULT</th><th>TYPE</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td>PARAMETER</td><td>REQUIRED</td><td>DEFAULT</td><td>TYPE</td><td>DESCRIPTION</td></tr><tr><td><strong>name</strong></td><td>true</td><td>NULL</td><td>String</td><td>Name</td></tr><tr><td><strong>description</strong></td><td>false</td><td>NULL</td><td>String</td><td>Description</td></tr><tr><td><strong>sn</strong></td><td>false</td><td>NULL</td><td>String</td><td>Uniform business number</td></tr><tr><td><strong>domains</strong></td><td>fale</td><td>Null</td><td>Array</td><td>Corporate domain</td></tr></tbody></table>

### Response

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