Logto API references

Get organization user members

GET /api/organizations/{id}/users

Get users that are members of the specified organization for the given query with pagination.

Path parameters

id string Required

The unique identifier of the organization.

Query parameters

q string

The query to filter users. It will match multiple fields of users, including ID, name, username, email, and phone number.

If not provided, all users will be returned.
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

A list of users that are members of the organization.
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
- organizationRoles array[object] Required
  
  Hide organizationRoles attributes Show organizationRoles attributes object
  
  id string Required
  
  name string Required
• 400

Bad Request
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

GET /api/organizations/{id}/users

curl \
 -X GET https://[tenant_id].logto.app/api/organizations/{id}/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,
    "organizationRoles": [
      {
        "id": "string",
        "name": "string"
      }
    ]
  }
]