> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.orderupb2b.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.orderupb2b.com/_mcp/server.

# 查詢客戶總部清單

GET https://api.example.com/v1/company-groups

⚠️ 群組決定資料可見範圍：總部客戶的 Boss 角色使用者看得到群組內所有成員的資料。這支端點只讀取，不會改變可見範圍。

分頁查詢客戶總部清單，依群組序號由小到大排列，每一列的形狀與「查詢單一客戶總部」相同。可用 `name` 篩選群組名稱，大小寫不敏感的子字串比對，前後空白會被忽略。沒有 `updatedSince` 篩選。

`page` 從 1 起算，`pageSize` 為 1–100（預設 100），超出範圍一律回 400。

Reference: https://docs.orderupb2b.com/api-規格/company-groups/list-company-groups

## Authentication

- `X-Signature` header (required) — 每個 /v1 請求都必須帶 `X-Client-Id`、`X-Timestamp`、`X-Nonce` 與 `X-Signature` 四個標頭。`X-Signature` 是以 client secret 對 canonical string 做 HMAC-SHA256 後的 Base64。 canonical string 的組成、可複製的簽章範例與 401 排查步驟，請參閱[「驗證與簽章」](/authentication)。

## Request

### Query parameters

- `name` (string, optional) — 依群組名稱篩選。大小寫不敏感的子字串比對，前後空白會被忽略。
- `page` (integer, optional) — 頁碼，從 1 起算，省略時預設 1。小於 1 回傳 400 invalid_page；頁碼大到讓內部位移量溢位時同樣回傳 400 invalid_page。
- `pageSize` (integer, optional) — 每頁筆數，範圍 1 至 100，省略時預設 100。超出範圍一律回傳 400 invalid_page_size，不會自動夾限成合法值，避免分批掃描時誤判為已經抓完全部資料。

## Response

### 200

OK

- `data` (list of CompanyGroupResponse, optional, nullable) — 本頁的客戶總部資料，每一筆為一筆客戶總部資料，形狀與「查詢單一客戶總部」的回應相同。
- `totalCount` (integer, optional) — 符合篩選條件的客戶總部總數，涵蓋所有頁，不受目前頁碼影響。
- `currentPage` (integer, optional) — 目前頁碼，即請求帶入的 page，從 1 起算。
- `pageSize` (integer, optional) — 目前頁面的筆數上限，即請求帶入的 pageSize。
- `totalPages` (integer, optional) — 總頁數，等於 totalCount 除以 pageSize 後無條件進位；沒有符合的資料時為 0。

## Errors

### 400 Bad Request Error

Bad Request

- `error` (string, optional, nullable) — 錯誤代碼，固定為 snake_case 字串，依代碼判斷失敗原因。

### 401 Unauthorized Error

Unauthorized

- `error` (string, optional, nullable) — 錯誤代碼，固定為 snake_case 字串，依代碼判斷失敗原因。

### 403 Forbidden Error

Forbidden

- `error` (string, optional, nullable) — 錯誤代碼，固定為 snake_case 字串，依代碼判斷失敗原因。

### 500 Internal Server Error

Internal Server Error

- `code` (string, optional, nullable) — 錯誤代碼字串。
- `message` (string, optional, nullable) — 對應的錯誤說明文字。

## Types

### CompanyGroupResponse

客戶總部的讀取內容，GET /v1/company-groups/\{id} 直接回傳，GET /v1/company-groups 的每一列也是同一個形狀。由一家總部客戶加上它底下的子客戶組成；總部客戶的 Boss 角色使用者看得到群組內所有成員的資料。

- `id` (long, optional) — 群組序號。
- `name` (string, optional, nullable) — 群組名稱。
- `parentCompany` (CompanyGroupMemberResponse, optional) — 總部客戶。建立群組後不能更換。
- `subCompanies` (list of CompanyGroupMemberResponse, optional, nullable) — 子客戶清單，不含總部本身，依客戶序號由小到大排列，只列出有效的客戶。

### CompanyGroupMemberResponse

客戶總部裡的一位成員（總部客戶或子客戶）。總部客戶若已被刪除，`outerSysCode` 與 `name` 為空字串，`id` 仍會回傳。

- `id` (long, optional) — 客戶序號。
- `outerSysCode` (string, optional, nullable) — ERP 端的客戶代碼。
- `name` (string, optional, nullable) — 企業名稱。

## Examples

**Response**

```json
{
  "data": [
    {
      "id": 1,
      "name": "string",
      "parentCompany": {
        "id": 1,
        "outerSysCode": "string",
        "name": "string"
      },
      "subCompanies": [
        {
          "id": 1,
          "outerSysCode": "string",
          "name": "string"
        }
      ]
    }
  ],
  "totalCount": 1,
  "currentPage": 1,
  "pageSize": 1,
  "totalPages": 1
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/v1/company-groups"

headers = {"X-Signature": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/v1/company-groups';
const options = {method: 'GET', headers: {'X-Signature': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/company-groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Signature", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/company-groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Signature"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/company-groups")
  .header("X-Signature", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/v1/company-groups', [
  'headers' => [
    'X-Signature' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/v1/company-groups");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Signature", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Signature": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/v1/company-groups")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```