Documentation

Mistake on this page? Email us

Options to use when listing users UserListOptions

Hierarchy

Index

Properties

after

after: string

The ID of the item after which to retrieve the next page

filter

filter: UserFilter

The user filter Filter for User

Constructed like so:

 filter: {
   status: { $eq: "INVITED" },
   email: { $eq: "email@email.com" },
 }

include

include: IncludeEnum | string | Array<IncludeEnum | string>

Optional fields to include

limit

limit: number

How many objects to retrieve in the page (Page size)

maxResults

maxResults: number

Number of results to retrieve

order

order: Order

ASC or DESC

pageSize

pageSize: number

The number of results to return in a page

Methods

mapResults

  • mapResults(item: any, index?: number): any
  • mapper function to apply to all results of the pagination

    Parameters

    • item: any
    • Optional index: number

    Returns any