List users
GET/user.list
List workspace members, or hydrate an explicit ordered set of principal IDs.
Without ids, this is the active workspace member directory: guests,
bots, and archived/deactivated members are never enumerated. Members are
returned in the order they were added to the account.
With ids, the endpoint becomes an unpaginated principal hydrator. Pass one
comma-separated value containing at most 100 bare or tagged IDs. Duplicate
tokens are deduplicated in first-seen order; resolved entries are returned
in that order. Unknown IDs, groups, and unauthorized principals are silently
omitted. Explicit lookup may resolve archived/deactivated users and
authorized automated actors. The response keeps the existing users key
but its entries are principals, and nextCursor is omitted.
ids cannot be combined with q, limit, or cursor. expand=status
remains supported in either mode.
Required scope: user:read (add user:read.email to include email addresses, user:read.status to expand presence status and willReturn)
Access: Organization and Personal.
OpenAPI Spec: chat-v1.json
Request
Responses
- 200
- 400
- 401
- 405
- 500
Directory members or explicitly hydrated principals retrieved successfully.
Bad request, including malformed/empty IDs, more than 100 raw tokens, repeated ids parameters, or ids combined with q, limit, or cursor.
Presented invalid authentication credentials.
An unsupported method was requested.
An internal error occurred.