GAganjoor
AppUser

(Auth)

Changed on
get/api/users

Request

  • Base URL
    https://api.ganjoor.net (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Query parameters

PageNumberinteger

page number starting from 1

PageSizeinteger

settable page size (-1 == all items, 1000 maxpagesize)

filterByEmailstring
filterByNickNamestring
filterByLockedOutboolean
filterByPhoneNumberstring
filterByUnverifiedboolean

Response

OK

idstring uuid nullable

Id

usernamestring nullable

User Name

emailstring email nullable

User Email

phoneNumberstring tel nullable

User Mobile Phone Number

firstNamestring nullable

First Name

surNamestring nullable

SurName

status0 | 1 required

User Status

rImageIdstring uuid nullable

user image

nickNamestring nullable

nick name

biostring nullable

biography

websitestring nullable

web site

emailConfirmedboolean

email verified

phoneNumberConfirmedboolean
createDatestring date-time

create date

lockedOutboolean
lockoutEndstring date-time nullable
lockoutMessagestring nullable

Example response

[
  {
    "username": "test",
    "email": "email@domain.com",
    "phoneNumber": "+989121234567",
    "firstName": "Hamid Reza",
    "surName": "Mohammadi"
  }
]

Changes

  • 493e82d8a523Revision changes
    • info

      added the new optional query request parameter filterByLockedOut

    • info

      added the new optional query request parameter filterByPhoneNumber

    • info

      added the new optional query request parameter filterByUnverified

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status