v1

latestOpenAPI 3.0.12026-08-0435481.5 MB

Users

Get users

Get users with filters and pagination.

Logto provides a very flexible way to query users. You can filter users by almost any fields with multiple modes. To learn more about the query syntax, please refer to Advanced user search.

get/api/users

Query parameters

pageinteger

Page number (starts from 1).

page_sizeinteger

Entries per page.

search_paramsobject

Search query parameters.

Response

An array of users that match the given criteria.

idstring required

usernamestring nullable required

primaryEmailstring nullable required

primaryPhonestring nullable required

namestring nullable required

avatarstring nullable required

customDataobject required

arbitrary

identitiesobject required

lastSignInAtnumber nullable required

createdAtnumber required

updatedAtnumber required

applicationIdstring nullable required

isSuspendedboolean required

hasPasswordboolean

hasSecurityVerificationMethodboolean

passwordDigeststring nullable