Struct GetUsersRequest

Namespace

Vonage.Users.GetUsers

Assembly

Vonage.dll

Represents a request to retrieve a paginated list of users with optional filtering and sorting options.

public readonly struct GetUsersRequest : IVonageRequest

Implements

IVonageRequest

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Cursor

The pagination cursor for retrieving the next or previous page of results. This value is automatically extracted from the _links.next.href or _links.prev.href in the response and should not be set manually.

public Maybe<string> Cursor { get; }

Property Value

Maybe<string>

Name

Filters results to users matching this unique name. When specified, only users with an exact name match are returned.

public Maybe<string> Name { get; }

Property Value

Maybe<string>

Order

The sort order for the results. Use Ascending for oldest first or Descending for newest first.

public FetchOrder Order { get; }

Property Value

FetchOrder

PageSize

The maximum number of user records to return per page. Defaults to 10 if not specified.

public int PageSize { get; }

Property Value

int

Methods

Build()

Initializes a builder for creating a GetUsersRequest with optional parameters.

public static IBuilderForOptional Build()

Returns

IBuilderForOptional

A builder instance for configuring the request.

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.

GetEndpointPath()

public string GetEndpointPath()

Returns

string