GET/partners/customers

顧客企業リストを取得する。並び順は内部ロジックにより整列されない場合がある。

注意
productId プロパティには、LINE WORKSサービスの情報のみを含みます。
productId プロパティは、将来の廃止を予定しています。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

partner
partner.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/partners/customers

Query Parameters

ParameterTypeDescription
domain string 

ドメイン名


example : example.com 
count integer 

取得数


default : 10
minimum : 1
maximum : 30 
cursor string 

リストのカーソル値


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
orderBy string 

ソート

  • ソートフィールド:
    • name : 名前 (既定)
  • 並び順:
    • asc : 昇順 (既定)
    • desc : 降順 ソートフィールドと並び順はスペースで区切る (separator: %20)

default : name%20asc
example : name%20desc 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
customers array (Customers) 

顧客企業リスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

Customers

PropertyTypeDescription
tenantId integer 

テナント ID


required
readOnly : true 
domainId integer 

ドメイン ID


required
readOnly : true 
domain string 

ドメイン名


required 
productId string 

商品 ID

  • FR : Free
  • STD_T : Standard Trial
  • ADV_T : Advanced Trial
  • STD : Standard
  • ADV : Advanced

注意
productId は将来の廃止を予定しています。


Allowed values : FR, STD_T, ADV_T, STD, ADV
nullable : true 
companyName string 

顧客企業/団体名


required 
phoneNumber string 

電話番号


required 
timeZone string 

タイムゾーンコード


required 
locale string 

言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_TW, zh_CN 
enableActiveMxrecord boolean 

MX レコード設定有効フラグ


required 
enableActiveDomain boolean 

ドメイン所有権有効フラグ


required 
domainType string 

ドメインタイプ

  • DOMAIN : ドメイン
  • GROUP : グループ

required
Allowed values : DOMAIN, GROUP 
administrator object (administrator) 

管理者情報

 
partnership object (partnership) 

ドメイン情報

 

administrator

PropertyTypeDescription
lastName string 

姓


required 
firstName string 

名

 
id string 

ユーザー ID


required 
privateEmail string 

個人メールアドレス


required
format : email 
cellphone string 

携帯電話番号

 
countryCode string 

国家コード

 

partnership

PropertyTypeDescription
status string 

パートナー状態

  • TRANSFER_READY : Online Direct からパートナーに転換した後、顧客企業が承認する前の待機状態
  • TERMS_AGREEMENT_READY : 規約に同意する前の状態
  • APPROVED : パートナーシップが締結された状態

Allowed values : TRANSFER_READY, TERMS_AGREEMENT_READY, APPROVED 
customerCode string 

管理用識別コード


maxLength : 200 
enablePartnerProfileDisplay boolean 

パートナープロフィール表示有効フラグ

 
memo string 

メモ


maxLength : 700 
enableDeveloperConsoleAccessControl boolean 

Developer Console のアクセス許可有効フラグ

 
enableAdminConsoleAccessControl boolean 

管理者画面アクセス許可有効フラグ

 
useOptionPlus boolean 

オプションプラス契約済みフラグ (廃止済み。常に true)

 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

1{2  "customers": [3    {4      "tenantId": 10000001,5      "domainId": 10000001,6      "domain": "example.com",7      "productId": "STD_T",8      "companyName": "ワークスモバイルジャパン株式会社",9      "phoneNumber": "03-0000-0000",10      "timeZone": "Asia/Tokyo",11      "locale": "ja_JP",12      "enableActiveMxrecord": true,13      "enableActiveDomain": true,14      "domainType": "DOMAIN",15      "administrator": {16        "lastName": "ワークス",17        "firstName": "管理者",18        "id": "companyadmin",19        "privateEmail": "private.works@example.com",20        "cellphone": "090-0000-0000",21        "countryCode": "+81"22      },23      "partnership": {24        "status": "TRANSFER_READY",25        "customerCode": "asd123ada11",26        "enablePartnerProfileDisplay": true,27        "memo": "memo",28        "enableDevelopersAccess": true,29        "enableAdminAccess": true,30        "useOptionPlus": true31      }32    }33  ],34  "responseMetaData": {35    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="36  }37}

HTTP 400

Bad request