Documentation

Mistake on this page? Email us

UserListOptions Options to use when listing users

Hierarchy

Index

Properties

after

after: string

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

filter

filter: object

Filter for User The user filter

Constructed like so:

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

Type declaration

include

include: string | Array<IncludeEnum>

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