Get users

GET /api/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.

Query parameters

  • page integer

    Page number (starts from 1).

    Minimum value is 1. Default value is 1.

  • page_size integer

    Entries per page.

    Minimum value is 1. Default value is 20.

Responses

GET /api/users
curl \
 -X GET https://[tenant_id].logto.app/api/users
Response examples (200)
[
  {
    "id": "string",
    "username": "string",
    "primaryEmail": "string",
    "primaryPhone": "string",
    "name": "string",
    "avatar": "string",
    "customData": {},
    "identities": {},
    "lastSignInAt": 42.0,
    "createdAt": 42.0,
    "applicationId": "string",
    "isSuspended": true,
    "hasPassword": true,
    "ssoIdentities": [
      {
        "id": "string",
        "userId": "string",
        "issuer": "string",
        "identityId": "string",
        "detail": {},
        "createdAt": 42.0,
        "ssoConnectorId": "string"
      }
    ]
  }
]