Skip to content
Admin SDK

GetAdminUsersParams

Defined in: src/types/admin_user.ts:38

Parameters for listing admin users.

Properties

Section titled “Properties”

admin?

Section titled “admin?”

optional admin?: boolean

Defined in: src/types/admin_user.ts:46

Filter by admin status.

all?

Section titled “all?”

optional all?: boolean

Defined in: src/types/admin_user.ts:44

Whether to include all users.

num_records?

Section titled “num_records?”

optional num_records?: number

Defined in: src/types/admin_user.ts:52

Maximum number of records to return.

start_id?

Section titled “start_id?”

optional start_id?: string

Defined in: src/types/admin_user.ts:50

User ID to start pagination from.

superadmin?

Section titled “superadmin?”

optional superadmin?: boolean

Defined in: src/types/admin_user.ts:48

Filter by super admin status.

user_id?

Section titled “user_id?”

optional user_id?: string

Defined in: src/types/admin_user.ts:42

Filter by user ID.

user_name?

Section titled “user_name?”

optional user_name?: string

Defined in: src/types/admin_user.ts:40

Filter by username.