List User REST 端点

JoinDate

DateTime?

Used to limit to just users who have joined since the specified date.

否

Usernames

string

Used to limit to a specific set of users.

否

ContentIds

string

Comma separated list of ContentIds. Used to limit to a specific set of users as well as sort order if SoryBy is set to ContentIdsOrder

否

EmailAddress

string

Used to limit to a specific user based on email address.

否

RoleId

int?

Used to get a list of users for a role.

否

AccountStatus

string

Options are: ApprovalPending, Approved, Banned, Disapproved, All

否

IncludeHidden

bool

By default "hidden" users (like service accounts) will not be returned. Set IncludeHidden=true to return all users.

否

LastUpdatedUtcDate

DateTime?

Allows filtering by last updated date to get say the users updated in last 10 hours

否

SortBy

string

Options are: JoinedDate, Username, Website, Posts, Email, RecentPosts, DisplayName, ContentIdsOrder

否

SortOrder

string

Default for Score is Descending, otherwise Ascending.

否

PageSize

int?

Specify the number of results to return per page. If not set the default is 20. The max is 100.

否

PageIndex

int?

Specify the page number of paged results to return. Zero-based index. If not specified the default is 0.

否