GET/partners/customers/{domainId}

Gets customer information.

Caution
The productId property includes only the information about the LINE WORKS services.
Support for the productId property is scheduled to end.
For customer subscriptions, see Get subscriptions.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

partner
partner.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/partners/customers/{domainId}

Path Parameters

ParameterTypeDescription
domainId integer 

Domain ID


required
example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
tenantId integer 

tenant ID


required
readOnly : true 
domainId integer 

Domain ID


required
readOnly : true 
domain string 

Domain name


required 
productId string 

Plan ID

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

Caution
Support for productId is scheduled to end.


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

Customer company or organization name


required 
phoneNumber string 

Phone number


required 
timeZone string 

Time zone code


required 
locale string 

Language code


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

Indicates whether MX records are active.


required 
enableActiveDomain boolean 

Indicates whether the domain is active (or its ownership is verified).


required 
domainType string 

Domain type

  • DOMAIN: Domain
  • GROUP: Group

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

Administrator information

 
partnership object (partnership) 

Domain information

 

administrator

PropertyTypeDescription
lastName string 

Last name


required 
firstName string 

First name

 
id string 

User ID


required 
privateEmail string 

Personal email address


required
format : email 
cellphone string 

Mobile phone number

 
countryCode string 

Country code

 

partnership

PropertyTypeDescription
status string 

Partner status

  • TRANSFER_READY: Waiting for approval after the customer status changes from an online direct customer to the partner’s.
  • TERMS_AGREEMENT_READY: Before the agreement of terms
  • APPROVED: Partnership established

Allowed values : TRANSFER_READY, TERMS_AGREEMENT_READY, APPROVED 
customerCode string 

Customer code (up to 200 bytes)

 
enablePartnerProfileDisplay boolean 

Indicates whether to make the partner profile visible.

 
memo string 

Memo


maxLength : 700 
enableDeveloperConsoleAccessControl boolean 

Indicates whether to enable access to the Developer Console.

 
enableAdminConsoleAccessControl boolean 

Indicates whether to enable access to the Admin Console.

 
useOptionPlus boolean 

Indicates whether to use Option Plus (Obsolete. Always true).

 

Response Example

example

1{2  "tenantId": 10000001,3  "domainId": 10000001,4  "domain": "example.com",5  "productId": "STD_T",6  "companyName": "LINE WORKS Corp.",7  "phoneNumber": "03-0000-0000",8  "timeZone": "Asia/Tokyo",9  "locale": "ja_JP",10  "enableActiveMxrecord": true,11  "enableActiveDomain": true,12  "domainType": "DOMAIN",13  "administrator": {14    "lastName": "Works",15    "firstName": "Administrator",16    "id": "admin",17    "privateEmail": "private.works@example.com",18    "cellphone": "090-0000-0000",19    "countryCode": "+81"20  },21  "partnership": {22    "status": "TRANSFER_READY",23    "customerCode": "asd123ada11",24    "enablePartnerProfileDisplay": true,25    "memo": "Memo",26    "enableDeveloperConsoleAccessControl": true,27    "enableAdminConsoleAccessControl": true,28    "useOptionPlus": true29  }30}

HTTP 404

Not Found

HTTP 500

Internal Server Error