Organizations

Get organization user members

Changed on

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

get/api/organizations/{id}/users

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/organizations/{id}/users
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

idstring required

The unique identifier of the organization.

Query parameters

qstring

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.

organizationRoleIdstring

The organization role ID used to filter organization members.

If not provided, all organization members will be returned.

pageinteger

Page number (starts from 1).

page_sizeinteger

Entries per page.

Response

A list of users that are members of the organization.

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
cimdClientIdstring nullable required

The identifier of the CIMD (client ID metadata document) client from the user's first consent. null unless the user's first consent was granted to a CIMD client. Mutually exclusive with applicationId.

isSuspendedboolean required

Changes