Help Center/Service Tickets/API Reference/API v2 (Recommended)/Ticket Query/Querying Sub-User Information
Updated on 2025-11-07 GMT+08:00
View PDF

Querying Sub-User Information

Function

Query sub-user information.

URI

GET /v2/servicerequest/customers/sub-customers

Table 1 Query parameters

Parameter

Mandatory

Type

Description

sub_customer_name

No

String

Specifies the sub-user name.

Minimum length: 0

Maximum length: 64

sub_customer_id

No

String

Specifies the sub-user ID.

Minimum length: 0

Maximum length: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1

Maximum length: 5000

X-Language

No

String

Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default.

Some internationalization information, such as the service ticket type and name, is displayed based on the language environment.

Minimum length: 1

Maximum length: 32

X-Time-Zone

No

String

Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default.

Time-related data is processed based on the time zone of the environment.

Minimum length: 1

Maximum length: 32

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

sub_customer_infos

Array of SubCutomerInfoV2 objects

Specifies the sub-user list.

Array length: 0 - 65535

Table 4 SubCutomerInfoV2

Parameter

Type

Description

mobile

String

Specifies the mobile phone number (anonymous).

Minimum length: 0

Maximum length: 32

email

String

Specifies the email address (anonymous).

Minimum length: 0

Maximum length: 256

customer_id

String

Specifies the customer ID.

Minimum length: 0

Maximum length: 64

domain_id

String

Specifies the master account ID.

Minimum length: 0

Maximum length: 64

customer_name

String

Specifies the customer name (anonymous).

Minimum length: 0

Maximum length: 256

area_code

String

Specifies the country/region code.

Minimum length: 0

Maximum length: 16

Request Example

None

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "sub_customer_infos" : [ {
    "mobile" : "123",
    "email" : "123",
    "customer_id" : "123",
    "domain_id" : "123",
    "customer_name" : "123",
    "area_code" : "86"
  } ]
}

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.

Parent topic:Ticket Query