通过属性值获取用户列表

POST

/public-api/user/properties/list

接口简介

通过用户属性值，查询用户列表

请求参数

Body 参数application/json

token

string

账户同步令牌

必需

userPropertyKey

string

用户属性键

必需

userPropertyValue

string

用户属性值

必需

enabled

boolean

是否启用

可选

默认true

offset

integer

搜索结果的起始位置

可选

limit

integer

从起始位置取多少条

可选

示例

{
    "token": "string",
    "userPropertyKey": "string",
    "userPropertyValue": "string",
    "enabled": true,
    "offset": 0,
    "limit": 0
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/public-api/user/properties/list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "string",
    "userPropertyKey": "string",
    "userPropertyValue": "string",
    "enabled": true,
    "offset": 0,
    "limit": 0
}'

返回响应

🟢200成功

application/json

Body

result

string

结果

必需

response

object

响应结果

必需

total

integer

总数

必需

offset

integer

起始位置

必需

搜索结果的起始位置

limit

integer

多少条

必需

从起始位置取多少条

list

array [object {7}]

必需

示例

{
    "result": "string",
    "response": {
        "total": 0,
        "offset": 0,
        "limit": 0,
        "list": [
            {
                "uId": "string",
                "name": "string",
                "mobile": "string",
                "email": "string",
                "loginId": "string",
                "domId": "string",
                "role": [
                    "string"
                ]
            }
        ]
    }
}

修改于 2025-07-16 01:54:31

获取用户列表

修改用户状态