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

userId string optional

Example: al

User ID prefix to return. An empty value returns all users.

sort string optional

user_id|created_at|session_count|connection_count. created_at is the earliest creation time among the user's sessions, connections, and limit overrides. Defaults to created_at.

One of: created_at, user_id, session_count, connection_count

Default: created_at

sortDirection string optional

asc|desc. Defaults to desc.

One of: asc, desc

page integer optional

Example: 1

1-based page number. Values below 1 are treated as 1.

Default: 1

Min: 1

perPage integer optional

Example: 20

Page size. Defaults to 20; values above 100 are capped at 100.

Default: 20

Min: 1

Max: 100

Request Sample

Show Request Sample
import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const response = await client.v2.actionGateway.users.get();

Response Example

Show Response Example
{
  "user_ids": [
    "alice",
    "bob"
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 2
  }
}

More Information

See /v2/action-gateway/users in the API reference for additional detail on responses, headers, parameters, and more.

We can't find any results for your search.

Try using different keywords or simplifying your search terms.