开发工具

批量获取用户信息

开发中

POST

{endpoint_url}/users/batch/get

获取多个指定用户的信息，ID、名称、头像图片地址等。如多人协作时，侧边栏历史展示时需要展示多个用户的相关信息，此时会请求此接口。

请求参数

Path 参数

endpoint_url

string

必需

示例值:

Header 参数

X-Shimo-Token

string

必需

用于接入方对本次请求鉴权

Body 参数application/json

ids

array[string]

用户 ID 列表

必需

示例

{
  "ids": ["user1", "user2"]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '/users/batch/get' \
--header 'X-Shimo-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "ids": ["user1", "user2"]
}'

返回响应

🟢200成功

application/json

Body

array of:

string

必需

接入方系统的用户的 ID

name

string

必需

接入方系统的用户名称

avatar

string

必需

接入方系统的用户的头像地址

string

必需

接入方系统的用户的邮箱

示例

[
    {
        "id": "userid123",
        "name": "张三",
        "avatar": "http://fake.site/user-123.png",
        "email": "user123@fake.site"
    },
    {
        "id": "userid1234",
        "name": "李四",
        "avatar": "http://fake.site/user-123.png",
        "email": "user123@fake.site"
    }
]

修改于 2024-03-19 08:39:26

获取用户部门路径

获取团队下的成员列表