dots.v2.actionGateway.users.get()
Generated on 13 Nov 2026
from DoTs version
v1.24.0
Usage
client.v2.actionGateway.users.get(requestConfiguration?: RequestConfiguration<UsersRequestBuilderGetQueryParameters>): Promise<undefined | List_users_response>Description
Returns the user IDs known for your team: session actor_id values, the user_id of connections that are not revoked, and actors with limit overrides. Only sessions and connections you can see count. Offset-paged with page and per_page.
Parameters
userIdstring optionalExample:
alUser ID prefix to return. An empty value returns all users.
sortstring optionaluser_id|created_at|session_count|connection_count.created_atis the earliest creation time among the user's sessions, connections, and limit overrides. Defaults tocreated_at.sortDirectionstring optionalasc|desc. Defaults to desc.
pageinteger optionalExample:
11-based page number. Values below 1 are treated as 1.
perPageinteger optionalExample:
20Page size. Defaults to 20; values above 100 are capped at 100.
Request Sample
Response Example
More Information
See /v2/action-gateway/users in the API reference for additional detail on responses, headers, parameters, and more.