All Implemented Interfaces:

com.braintrustdata.api.core.Params
```
public final class UserListParams
 implements Params
                    
```
List out all users. The users are sorted by creation date, with the most recently-created users coming first

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`UserListParams.Builder`	A builder for UserListParams.
`public final class`	`UserListParams.Email`	Email of the user to search for. You may pass the param multiple times to filter for more than one email
`public final class`	`UserListParams.FamilyName`	Family name of the user to search for. You may pass the param multiple times to filter for more than one family name
`public final class`	`UserListParams.GivenName`	Given name of the user to search for. You may pass the param multiple times to filter for more than one given name
`public final class`	`UserListParams.Ids`	Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<UserListParams.Email>`	`email()`	Email of the user to search for.
`final Optional<String>`	`endingBefore()`	Pagination cursor id.
`final Optional<UserListParams.FamilyName>`	`familyName()`	Family name of the user to search for.
`final Optional<UserListParams.GivenName>`	`givenName()`	Given name of the user to search for.
`final Optional<UserListParams.Ids>`	`ids()`	Filter search results to a particular set of object IDs.
`final Optional<Long>`	`limit()`	Limit the number of objects to return
`final Optional<String>`	`orgName()`	Filter search results to within a particular organization
`final Optional<String>`	`startingAfter()`	Pagination cursor id.
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final UserListParams.Builder`	`toBuilder()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static UserListParams`	`none()`
`final static UserListParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of UserListParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - email
```
 final Optional<UserListParams.Email> email()
```
    Email of the user to search for. You may pass the param multiple times to filter for more than one email
  - endingBefore
```
 final Optional<String> endingBefore()
```
    Pagination cursor id.
    For example, if the initial item in the last page you fetched had an id of foo, pass ending_before=foo to fetch the previous page. Note: you may only pass one of starting_after and ending_before
  - familyName
```
 final Optional<UserListParams.FamilyName> familyName()
```
    Family name of the user to search for. You may pass the param multiple times to filter for more than one family name
  - givenName
```
 final Optional<UserListParams.GivenName> givenName()
```
    Given name of the user to search for. You may pass the param multiple times to filter for more than one given name
  - ids
```
 final Optional<UserListParams.Ids> ids()
```
    Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times
  - limit
```
 final Optional<Long> limit()
```
    Limit the number of objects to return
  - orgName
```
 final Optional<String> orgName()
```
    Filter search results to within a particular organization
  - startingAfter
```
 final Optional<String> startingAfter()
```
    Pagination cursor id.
    For example, if the final item in the last page you fetched had an id of foo, pass starting_after=foo to fetch the next page. Note: you may only pass one of starting_after and ending_before
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final UserListParams.Builder toBuilder()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static UserListParams none()
```
  - builder
```
 final static UserListParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of UserListParams.

Class UserListParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

email

endingBefore

familyName

givenName

ids

limit

orgName

startingAfter

_additionalHeaders

_additionalQueryParams

toBuilder

_headers

_queryParams

equals

hashCode

toString

none

builder