English ← MyDocs

列出用户

get /v1/organizations/users

列出用户

查询参数

  • after_id: optional string

    用作分页游标的对象 ID。提供后,将返回该对象之后的结果页。

  • before_id: optional string

    用作分页游标的对象 ID。提供后,将返回该对象之前的结果页。

  • email: optional string

    按用户邮箱筛选。

  • limit: optional number

    每页返回的条目数。

    默认为 20。范围为 11000

返回值

  • data: array of User

    • id: string

      用户的 ID。

    • added_at: string

      RFC 3339 日期时间字符串,表示用户加入组织的时间。

    • email: string

      用户的邮箱。

    • name: string

      用户的姓名。

    • role: "user" or "developer" or "billing" or 2 more

      用户在组织中的角色。

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • type: "user"

      对象类型。

      对于用户,始终为 "user"

      • "user"
  • first_id: string

    data 列表中的第一个 ID。可用作上一页的 before_id

  • has_more: boolean

    指示在请求的分页方向上是否还有更多结果。

  • last_id: string

    data 列表中的最后一个 ID。可用作下一页的 after_id

示例

curl https://api.anthropic.com/v1/organizations/users \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "data": [
    {
      "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
      "added_at": "2024-10-30T23:58:27.427722Z",
      "email": "user@emaildomain.com",
      "name": "Jane Doe",
      "role": "user",
      "type": "user"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}