Logto API references

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

• 200 application/json

An array of users that match the given criteria.
Hide response attributes Show response attributes object
- id string Required
  
  Minimum length is 1, maximum length is 12.
- username string | null Required
  
  Maximum length is 128.
- primaryEmail string | null Required
  
  Maximum length is 128.
- primaryPhone string | null Required
  
  Maximum length is 128.
- name string | null Required
  
  Maximum length is 128.
- avatar string | null Required
  
  Maximum length is 2048.
- customData object Required
  
  arbitrary
- identities object Required
  
  Hide identities attributes Show identities attributes
  
  Additional properties
  
  userId string
  
  details object
  
  arbitrary
- lastSignInAt number | null Required
- createdAt number Required
- updatedAt number Required
- profile object Required
  
  Hide profile attributes Show profile attributes
  
  familyName string
  
  givenName string
  
  middleName string
  
  nickname string
  
  preferredUsername string
  
  profile string
  
  website string
  
  gender string
  
  birthdate string
  
  zoneinfo string
  
  locale string
  
  address object
  
  Hide address attributes Show address attributes
  
  formatted string
  
  streetAddress string
  
  locality string
  
  region string
  
  postalCode string
  
  country string
- applicationId string | null Required
  
  Maximum length is 21.
- isSuspended boolean Required
- hasPassword boolean
- ssoIdentities array[object]
  
  Hide ssoIdentities attributes Show ssoIdentities attributes object
  
  id string Required
  
  Minimum length is 1, maximum length is 21.
  
  userId string Required
  
  Minimum length is 1, maximum length is 12.
  
  issuer string Required
  
  Minimum length is 1, maximum length is 256.
  
  identityId string Required
  
  Minimum length is 1, maximum length is 128.
  
  detail object Required
  
  arbitrary
  
  createdAt number Required
  
  ssoConnectorId string Required
  
  Minimum length is 1, maximum length is 128.
• 400

Bad Request
• 401

Unauthorized
• 403

Forbidden

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": {
      "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": [
      {
        "id": "string",
        "userId": "string",
        "issuer": "string",
        "identityId": "string",
        "detail": {},
        "createdAt": 42.0,
        "ssoConnectorId": "string"
      }
    ]
  }
]