Skip to main content

List users

The station's people, one page at a time, ordered by when their account was made

GET /users

note

SDK method: listUsers Security: authenticated (policy: platform.manage)

Attributes​

Attributes (7)
AttributeTypeRequiredDescription
totalnumberYesThe total number of items
activebooleanNoOptionally filter by whether the items are active
pagenumberNoThe page number
pageSizenumberNoThe page size
rolePlatformRoleNoOnly people holding this role
searchstringNoPart of an email address
sort'asc' | 'desc'NoThe sort order

Response​

200 OK — Returns a UserPage object.