Sign in
Users

Get a list of users

Required scope - read_user

get/api/v1/users

Query parameters

page_sizeinteger

Number of users to return per page

page_numberinteger

Page number to return

searchstring

Search by name or email

Response

A list of users

countinteger

Total number of users matching the query

Changes

Changed in 11 of the 50 revisions of this API.20447

  • 74c633c2da2c1See the full diff
    • ○

      added the optional property users/items/invitationExpiresAt to the response with the 200 status

      response-optional-property-added

  • e8542f1e3a761See the full diff
    • ○

      added the required property users/items/isInviting to the response with the 200 status

      response-required-property-added

  • 50ad4103f227119See the full diff
    • ▲

      the users/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ○

      added the optional property users/items/linkedAuthId to the response with the 200 status

      response-optional-property-added

    • ○

      removed User subschema #2 from the users/items/ response property allOf list for the response status 200

      response-property-all-of-removed

    • ○

      added the required property users/items/authId to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/createdAt to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/deletedAt to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/email to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/emailVerified to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/firstName to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/isActive to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/lastName to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/locale to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/loginCount to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/mfaTypes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/otpVerified to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/smsPhoneNumberVerified to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/socialAccountId to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/socialAccountType to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/updatedAt to the response with the 200 status

      response-required-property-added

  • 1956019598a71See the full diff
    • ○

      added the optional property users/items/allOf[User]/linkedAuthId to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 795cad873b4718See the full diff
    • ○

      the response property users/items/allOf[User]/authId became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/createdAt became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/deletedAt became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/email became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/emailVerified became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/firstName became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/id became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/isActive became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/lastName became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/locale became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/otpVerified became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/smsPhoneNumberVerified became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/socialAccountId became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/socialAccountType became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[User]/updatedAt became required for the status 200

      response-property-became-required

    • ○

      the response property users/items/allOf[subschema #2]/roles became required for the status 200

      response-property-became-required

    • ○

      added the required property users/items/allOf[User]/loginCount to the response with the 200 status

      response-required-property-added

    • ○

      added the required property users/items/allOf[User]/mfaTypes to the response with the 200 status

      response-required-property-added

  • 192da8a641d01See the full diff
    • ○

      added the optional property users/items/allOf[User]/smsPhoneNumberVerified to the response with the 200 status

      response-optional-property-added

  • 1f092af5030c12See the full diff
    • ●

      removed the optional property users/items/allOf[User]/googleId from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property users/items/allOf[User]/socialAccountId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property users/items/allOf[User]/socialAccountType to the response with the 200 status

      response-optional-property-added

  • 131e51c870ea1See the full diff
    • ○

      added the new optional query request parameter search

      new-optional-request-parameter

  • 6c0a71f4107a1See the full diff
    • ○

      added the optional property users/items/allOf[User]/googleId to the response with the 200 status

      response-optional-property-added

  • 3c591337acf21See the full diff
    • ○

      added the optional property users/items/allOf[User]/otpVerified to the response with the 200 status

      response-optional-property-added