Get users

GET /api/users
OAuth2

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.

  • search_params object

    Search query parameters.

    Hide search_params attribute Show search_params attribute object
    • * string Additional properties

Responses

GET /api/users 
curl \
 -X GET https://[tenant_id].logto.app/api/users \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "id": "string",
    "username": "string",
    "primaryEmail": "string",
    "primaryPhone": "string",
    "name": "string",
    "avatar": "string",
    "customData": {},
    "identities": {
      "additionalProperty1": {
        "userId": "string",
        "details": {}
      },
      "additionalProperty2": {
        "userId": "string",
        "details": {}
      }
    },
    "lastSignInAt": 42.0,
    "createdAt": 42.0,
    "updatedAt": 42.0,
    "profile": {
      "familyName": "string",
      "givenName": "string",
      "middleName": "string",
      "nickname": "string",
      "preferredUsername": "string",
      "profile": "string",
      "website": "string",
      "gender": "string",
      "birthdate": "string",
      "zoneinfo": "string",
      "locale": "string",
      "address": {
        "formatted": "string",
        "streetAddress": "string",
        "locality": "string",
        "region": "string",
        "postalCode": "string",
        "country": "string"
      }
    },
    "applicationId": "string",
    "isSuspended": true,
    "hasPassword": true,
    "ssoIdentities": [
      {
        "tenantId": "string",
        "id": "string",
        "userId": "string",
        "issuer": "string",
        "identityId": "string",
        "detail": {},
        "createdAt": 42.0,
        "ssoConnectorId": "string"
      }
    ]
  }
]