Users

Get a paginated list of users.

Possible status values: Locked (account has been locked), Activated (user has logged in at least once), Invited (invited but has not yet verified their email), Pending login (verified email but has not yet logged in).

get/api/v1/Users

Request

Base URL
https://api.slopesoftware.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/slopesoftware/apis/akur8-life-api/docs/api/v1/Users/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

Limitinteger

Optional parameter to limit the number of items returned. Default is 200 and the max is 200.

Fieldsstring

Optional parameter to filter the top-level fields that are returned. The list must be in CSV format. Example: field1,field2,field3

Offsetinteger

Optional parameter to offset the items returned. Default is 0.

Response

userEmailstring nullable

User's Email

userNamestring nullable

User's Name

rolesstring nullable

User's Roles

statusstring nullable

User's Status

lastVisitDatestring date-time nullable

User's Last Visit Date

Changes

No recorded changes to this operation across all 1 revision of this API.

Get a paginated list of users.

Request

Query parameters

Response 200OK

Changes

Response