AdminGetUsersParams

Parameters used to filter and configure the pagination of the retrieved users.

Properties

idstring | string[]

IDs to filter users by.

qstring

Search terms to search users' first name, last name, and email.

orderstring

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

updated_atDateComparisonOperator

Date filters to apply on the users' update_at date.

created_atDateComparisonOperator

Date filters to apply on the customer users' created_at date.

deleted_atDateComparisonOperator

Date filters to apply on the users' deleted_at date.

emailstring

Filter to apply on the users' email field.

first_namestring

Filter to apply on the users' first_name field.

last_namestring

Filter to apply on the users' last_name field.

roleUserRole

Filter to apply on the users' role field.

fieldsstring

Comma-separated fields that should be included in the returned users.

expandstring

Comma-separated relations that should be expanded in the returned data.

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

limitnumber

Limit the number of items returned in the list.

Default: 20