Query Account Colleagues

Queries the colleague accounts of a specified account.

Request URL

GET {base_url}/uc-user/api/v1/accounts/{id}/colleagues

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.

x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
id Yes String The ID of the primary account. You can obtain the ID using the Search Resellers interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.

result Array<Colleague> The list of colleague accounts of the specified account.
Colleague
Parameter Type Description
id String The ID of the account.
ucId String The UC ID of the company that the account belongs to.
firstName String The first name of the user.
lastName String The last name of the user.
status String The status of the account.
email String The email address of the account, which is used as the login username.
company String The company name, which is inherited from the primary account.
phone String The phone number.
address String The address.
profileImage String The URL of the avatar.
twoFactorEnabled Boolean Whether two-factor authentication is enabled.
remark String The remark of the account.
createTime Integer The time when the account was created, in Unix timestamp format (milliseconds).

Example

Request example

GET /uc-user/api/v1/accounts/2085315948849827842/colleagues HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwiYXBwX2tleSI6Im9icWJUSWd1ZkJ5d3ZCNmF0VURmVDZpeDJvUlhUb0wzIiwiZ3JhbnRfdHlwZSI6Im9wZW5hcGkiLCJjbGllbnRfZXh0Ijp7ImRlc2NyaXB0aW9uIjoi56ys5LiJ5pa55ZCI5L2c5LyZ5Ly05bqU55SoIiwicGFydG5lciI6IuekuuS-i-WQiOS9nOS8meS8tCJ9LCJjbGllbnRfdHlwZSI6Im9wZW5hcGkiLCJleHAiOjE3OTIwNzI3NTcsImlhdCI6MTc5MjA1MTE1NywianRpIjoiOTVkOGM1YWMtNzg3MS00ZjlmLWFiOWUtYzFjOTBlYzU4N2M1IiwiY2xpZW50X2lkIjoibm92by1vcGVuLXBsYXRmb3JtIiwidXNlcl9leHQiOnsicm9sZUlkcyI6WzNdLCJzdHlwZSI6IkFETUlOIiwidGVuYW50Q29kZSI6bnVsbCwidHlwZSI6IlBfQUNDT1VOVCIsInVzZXJJZCI6MjA4NTMxNTk0ODg0OTgyNzg0MiwiZW1haWwiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwidXNlcm5hbWUiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwidWNJZCI6MjA4NTMxNTk0ODI4Nzc5MTEwNn19.AmC_hWm0Pa51VbO2YaQZF3gXofw5NQDi_njH-fPAi2r_kWc8PyxkK6vq212lTPHR-eDMY3CaXhUxptGNcUUXAHfbuFqHXBcLvZ1ggmMCYLlSpcsj9TBg3BULyvHOlJBEbO7b_OOBZi_fGG-Oe3e9m-EsdOjA150ZJKU9trq-QUqFndTvdMZV9JHDV2xpDwgKdT6v4xNhM9TaAT9_tLmOtSipIijx32ng8CIDd0l7jWYfrmwsjf32n0P232nXmKfdADjSuKAp8TNxc17ccFxt9k0aQlB9uyhGPjIdCHSK7hill2VbzVAGuVzj3b1AplQz2cAVmVhXqWqOfpfjM1tY9A

Response example

HTTP/1.1 200 OK
{
  "result": [
    {
      "id": "2087710274633515009",
      "ucId": "2085315948287791106",
      "firstName": "mt1000-C1",
      "lastName": "1",
      "status": "ACTIVE",
      "email": "mt1000-C1@mailstar.top",
      "company": "",
      "twoFactorEnabled": false,
      "createTime": 1786583891988
    }
  ],
  "requestId": "74fb26ed6ba206540d8f53b2ea7514c6",
  "code": "200",
  "message": "SUCCESS"
}
Note:

The response is condensed. The result array contains 22 items.