users

Find users

Find a user or users. You may query using field filters with asterisk (*) wildcards. You may also optionally specify sort, limit, offset, and a list of fields to include in the response. The global default limit will apply if no limit param is specified.

get/users

Query parameters

fieldsstring[]

Comma-delimited list of field names to include in the response.

sortstring[]

Specify the sort order using a field name, e.g. '...?sort=name'. Prepend the field name with a minus sign to specify descending order, e.g. '...?sort=-name'.

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

emailstring

Filter by email; asterisk (*) wildcards ok.

namestring

Filter by name; asterisk (*) wildcards ok.

createdAtstring

Filter by time period when users were created.

updatedAtstring

Filter by time period when users were updated.

Response

Success, a list of users.

emailstring

The user's email address.

idstring
imageUrlstring

Optional thumbnail image.

namestring

First and last name.

fullNamestring

The user's full name.

passwordstring
createdBystring

TODO

createdAtstring

TODO

updatedAtstring

TODO

Changes