Query Subordinate User List

Query the list of subordinate users.

Request URL

GET {base_url}/user/openapi/user/v1/client/partner_list

Request parameters

Headers


Parameter	Required	Description
User-Agent	Yes	Provide information about the user agent, such as the type of web browser, operating system, software version, etc., so as to help Yeastar Partner Portal to identify the user or the application that is making the request. Example: `User-Agent: OpenAPI`.
Authorization	Yes	Pass the access token in the header, so as to authenticate the API request. Format: Bearer `{access_token}`.

Query parameters

None.

Response parameters


Parameter	Type	Description
code	String	The response message of the API request.
detailMessage	String	The detailed error information. When the request is successful, this parameter returns empty.
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
result	Object<User_Info>	The detailed information of your subordinate users.
status	Integer	The HTTP status code of the API request.

User_Info


Parameter	Type	Description
city	String	City.
company	String	Company.
country	String	Country.
email	String	Email address.
firstName	String	First Name.
lastName	String	Last Name.
partnerId	String	The unique ID of the subordinate user.
phoneNumber	String	Phone number.
remark	String	Remark.
stateProvince	String	State / Province.
street	String	Street.
taxNum	String	Tax identification number.
userType	String	User type. `Enduser`
zipCode	String	ZIP / postal code.

Example

Request example

Query the list of subordinate users.

GET /user/openapi/user/v1/client/partner_list HTTP/1.1
Host: openapi.partner.yeastar.com
User-Agent: OpenAPI
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsicmVzMSJdLCJYLU1TLVVTRVIiOiJ7XCJleHByXCI6XCIwXCIsXCJ0eXBlXCI6XCJwYXJ0bmVyXCIsXCJ1Y0lkXCI6XCIzMDc2OTEzNjQ0ODkwODMyODk2XCIsXCJ1c2VyQ29kZVwiOlwiRGlzdHJpYnV0b3JcIixcInVzZXJJZFwiOlwiMzA3NjkxMzY0NDkxNTk5ODcyMFwiLFwidXNlcm5hbWVcIjpcImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbVwifSIsInVzZXJfbmFtZSI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInNjb3BlIjpbImFsbCJdLCJleHAiOjE3Mzk1MzIwNjQsInRva2VuX3R5cGUiOiJvcGVuYXBpIiwianRpIjoibXVSZDFEb2JOYkpmUUJORXAxa3JHcHZtcXJNPSIsImF1dGhvcml0aWVzIjpbIjc3Il0sImNsaWVudF9pZCI6ImFjMGYyZTViZWU3NmI2ZDdmNDU0NTY5NmMyNGZjMWYzIn0.h8x-JgOmB-as-GQJ4CWKdxXQ21z_3PPSfm1G87dgoNQ

Response example

{
    "code": "success",
    "detailMessage": "",
    "requestId": "ceff469ea2447906dd300bb2a97174bb",
    "result": [
        {
            "city": "Xiamen",
            "company": "Company Example",
            "country": "Algeria",
            "email": "color123@yeastar.com",
            "firstName": "Example",
            "lastName": "li",
            "partnerId": "3196166858895147008",
            "phoneNumber": "13600930000",
            "remark": "",
            "stateProvince": "Fujian",
            "street": "Siming"，
            "taxNum": "VAT_number:123123",
            "userType": "Enduser",
            "zipCode": "361000"
        },
        {
            "city": "City",
            "company": "Organization Test",
            "country": "South Africa",
            "email": "color@example.com",
            "firstName": "Color",
            "lastName": "",
            "partnerId": "3116438828188774400",
            "phoneNumber": "13600999900",
            "remark": "",
            "stateProvince": "xiamen",
            "street": "Street Test",
            "taxNum": "VAT_number:123123",
            "userType": "Enduser",
            "zipCode": "361000"
        },
        {
            "city": "Xiamen",
            "company": "Company Example",
            "country": "South Africa",
            "email": "example1@outlook.com",
            "firstName": "Example",
            "lastName": "LA",
            "partnerId": "3076915454489739264",
            "phoneNumber": "13600930000",
            "remark": "",
            "stateProvince": "Fujian",
            "street": "Siming",
            "taxNum": "VAT_number:123123",
            "userType": "Enduser",
            "zipCode": "361000"
        }
    ],
    "status": 200
}