Search My Colleagues

Request URL

POST {base_url}/uc-user/api/v1/accounts/me/colleagues/search-page

Request parameters

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	The access token used for authentication. Format: Bearer `{access_token}`.
x-tenant-code	No	String	The tenant name. Note: You can obtain tenant name using the Query Tenants interface.

Body parameters


Parameter	Required	Type	Description
pageSize	No	Integer	The number of records to retrieve per page.
pageNumber	No	Integer	The page number to retrieve.
sorts	No	Array<Sort_Condition>	The sort conditions.
keyword	No	String	The keyword used for fuzzy matching, which matches the first name, last name, and email address of accounts.
status	No	String	The status of the account, used to filter accounts.
name	No	String	The name of the user, used for fuzzy matching.
email	No	String	The email address, used for fuzzy matching.
createTimeStart	No	Integer	The start of the creation time, in Unix timestamp format (milliseconds).
createTimeEnd	No	Integer	The end of the creation time, in Unix timestamp format (milliseconds).
idList	No	Array<Integer>	The list of account IDs, which is passed in when exporting selected records and is ignored when empty.

Sort_Condition


Parameter	Required	Type	Description
property	No	String	The name of the field to sort by.
direction	No	String	The sort order. Valid value: `asc`: Sort in ascending order. `desc`: Sort in descending order.

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	Object<Colleague_Page_Result>	The search result of colleagues.

Colleague_Page_Result


Parameter	Type	Description
pageSize	Integer	The number of records per page.
pageNumber	Integer	The current page number.
total	Integer	The total number of records that match the search conditions.
totalPages	Integer	The total number of pages.
empty	Boolean	Whether the current page is empty.
results	Array<Colleague>	The list of colleagues that match the search conditions.

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

POST /uc-user/api/v1/accounts/me/colleagues/search-page 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
Content-Type: application/json
{
  "pageNumber": 1,
  "pageSize": 20,
  "keyword": ""
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "pageSize": 20,
    "pageNumber": 1,
    "total": 20,
    "results": [
      {
        "id": "2110619503837396994",
        "ucId": "2085315948287791106",
        "firstName": "A1C1初始权限（勿动）",
        "status": "ACTIVE",
        "email": "mt10558@mailstar.top",
        "company": "",
        "twoFactorEnabled": false,
        "remark": "Shuang-2504",
        "createTime": 1792045877883
      },
      {
        "id": "2109910903312936962",
        "ucId": "2085315948287791106",
        "firstName": "wac",
        "status": "INACTIVE",
        "email": "wangac@yeastar.com",
        "company": "",
        "twoFactorEnabled": false,
        "createTime": 1791876934335
      },
      {
        "id": "2109589687195840513",
        "ucId": "2085315948287791106",
        "firstName": "lumj-c1",
        "status": "ACTIVE",
        "email": "lumj-c1@126.com",
        "company": "",
        "twoFactorEnabled": false,
        "createTime": 1791800350460
      },
      {
        "id": "2101941184499351554",
        "ucId": "2085315948287791106",
        "firstName": "chenjm-A1C1@126.com",
        "status": "INACTIVE",
        "email": "chenjm-A1C1@126.com",
        "company": "",
        "twoFactorEnabled": false,
        "createTime": 1789976805305
      },
      {
        "id": "2100144822583730178",
        "ucId": "2085315948287791106",
        "firstName": "auto",
        "lastName": "test",
        "status": "ACTIVE",
        "email": "mt10016@mailstar.top",
        "company": "",
        "phone": "8612345678901",
        "address": "xiamen",
        "twoFactorEnabled": false,
        "remark": "remark",
        "createTime": 1789548519246
      },
      {
        "id": "2100143134846132225",
        "ucId": "2085315948287791106",
        "firstName": "auto",
        "lastName": "test",
        "status": "ACTIVE",
        "email": "mt10054@mailstar.top",
        "company": "",
        "phone": "8612345678901",
        "address": "xiamen",
        "twoFactorEnabled": false,
        "remark": "remark",
        "createTime": 1789548116858
      },
      {
        "id": "2100142523631181825",
        "ucId": "2085315948287791106",
        "firstName": "auto",
        "lastName": "test",
        "status": "ACTIVE",
        "email": "mt10007@mailstar.top",
        "company": "",
        "phone": "8612345678901",
        "address": "xiamen",
        "twoFactorEnabled": false,
        "remark": "remark",
        "createTime": 1789547971138
      },
      {
        "id": "2100139904426745858",
        "ucId": "2085315948287791106",
        "firstName": "auto",
        "lastName": "test",
        "status": "ACTIVE",
        "email": "mt10027@mailstar.top",
        "company": "",
        "phone": "8612345678901",
        "address": "xiamen",
        "twoFactorEnabled": false,
        "remark": "remark",
        "createTime": 1789547346665
      },
      {
        "id": "2098374106957447170",
        "ucId": "2085315948287791106",
        "firstName": "auto",
        "lastName": "test",
        "status": "ACTIVE",
        "email": "mt10038@mailstar.top",
        "company": "",
        "phone": "8612345678901",
        "address": "xiamen",
        "twoFactorEnabled": false,
        "remark": "remark",
        "createTime": 1789126347750
      },
      {
        "id": "2096768862174957569",
        "ucId": "2085315948287791106",
        "firstName": "助理",
        "status": "ACTIVE",
        "email": "byoimt1000c@yuxf.com",
        "company": "",
        "twoFactorEnabled": false,
        "createTime": 1788743627564
      },
      {
        "id": "2093325946157244418",
        "ucId": "2085315948287791106",
        "firstName": "suys同事",
        "status": "ACTIVE",
        "email": "suys_c1@yeastar.com",
        "company": "",
        "twoFactorEnabled": false,
        "remark": "Shuang-2504\nYeastar202",
        "createTime": 1787922772418
      },
      {
        "id": "2093246978687213569",
        "ucId": "2085315948287791106",
        "firstName": "chen",
        "lastName": "jingming",
        "status": "ACTIVE",
        "email": "chenjm-A1C@126.com",
        "company": "",
        "twoFactorEnabled": false,
        "createTime": 1787903945105
      },
      {
        "id": "2090412714858319874",
        "ucId": "2085315948287791106",
        "firstName": "苏苑霜同事账号",
        "status": "ACTIVE",
        "email": "mt10545@mailstar.top",
        "company": "",
        "twoFactorEnabled": false,
        "remark": "Shuang-2504",
        "createTime": 1787228203948
      },
      {
        "id": "2090308953740791809",
        "ucId": "2085315948287791106",
        "firstName": "余",
        "lastName": "慕",
        "status": "ACTIVE",
        "email": "52@126.com",
        "company": "",
        "profileImage": "https://minio.cn-0.test-byoi.novo-one.com/novo-one/public/platform/_GLOBAL/user_avatar/1787203453218/loginbgimage-light.jpg",
        "twoFactorEnabled": false,
        "createTime": 1787203465389
      },
      {
        "id": "2089919692777033729",
        "ucId": "2085315948287791106",
        "firstName": "lin",
        "lastName": "ajjjj",
        "status": "ACTIVE",
        "email": "mt10675@mailstar.top",
        "company": "",
        "twoFactorEnabled": false,
        "createTime": 1787110658336
      },
      {
        "id": "2087710274633515009",
        "ucId": "2085315948287791106",
        "firstName": "mt1000-C1",
        "lastName": "1",
        "status": "ACTIVE",
        "email": "mt1000-C1@mailstar.top",
        "company": "",
        "twoFactorEnabled": false,
        "createTime": 1786583891988
      },
      {
        "id": "2085742825506770945",
        "ucId": "2085315948287791106",
        "firstName": "auto",
        "lastName": "test",
        "status": "ACTIVE",
        "email": "mt10010@mailstar.top",
        "company": "",
        "phone": "8612345678901",
        "address": "xiamen",
        "twoFactorEnabled": false,
        "remark": "remark",
        "createTime": 1786114815565
      },
      {
        "id": "2085661620073566209",
        "ucId": "2085315948287791106",
        "firstName": "mt10022",
        "status": "ACTIVE",
        "email": "mt10022@mailstar.top",
        "company": "",
        "twoFactorEnabled": false,
        "createTime": 1786095454680
      },
      {
        "id": "2085535940715384834",
        "ucId": "2085315948287791106",
        "firstName": "A1C",
        "lastName": "caifengfang",
        "status": "ACTIVE",
        "email": "ystest9034@mailtest.top",
        "company": "",
        "phone": "10001",
        "address": "123",
        "twoFactorEnabled": false,
        "createTime": 1786065490385
      },
      {
        "id": "2085326079666851841",
        "ucId": "2085315948287791106",
        "firstName": "wac同事",
        "lastName": "wang",
        "status": "ACTIVE",
        "email": "wac@163.com",
        "company": "",
        "twoFactorEnabled": false,
        "createTime": 1786015455613
      }
    ],
    "totalPages": 1,
    "empty": false
  },
  "requestId": "8ee4de616cd5de31e02cc629191b04fa",
  "code": "200",
  "message": "SUCCESS"
}