user-resource

getAllUsers

get/api/users

Request

Query parameters

firstName.containsstring
firstName.doesNotContainstring
firstName.equalsstring
firstName.instring[]
firstName.notEqualsstring
firstName.notInstring[]
firstName.specifiedboolean
lastName.containsstring
lastName.doesNotContainstring
lastName.equalsstring
lastName.instring[]
lastName.notEqualsstring
lastName.notInstring[]
lastName.specifiedboolean
mobile.containsstring
mobile.doesNotContainstring
mobile.equalsstring
mobile.instring[]
mobile.notEqualsstring
mobile.notInstring[]
mobile.specifiedboolean
pageinteger

Page number of the requested page

plan.equals'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
plan.instring[]
plan.notEquals'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
plan.notInstring[]
plan.specifiedboolean
sizeinteger

Size of a page

sortstring[]

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

OK

activatedboolean
authoritiesstring[]
clubCodeinteger
clubType'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
createdBystring
createdDatestring date-time
emailstring
firstNamestring
gender'MALE' | 'FEMALE'
idinteger
imageUrlstring
langKeystring
lastModifiedBystring
lastModifiedDatestring date-time
lastNamestring
lockedboolean
loginstring
mobilestring
nicknamestring
plan'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'

Changes

No recorded changes to this operation across all 4 revisions of this API.