Organizations

Get organizations

Changed on

Get organizations that match the given query with pagination.

get/api/organizations

Request

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

Query parameters

qstring

The query to filter organizations. It can be a partial ID or name.

If not provided, all organizations will be returned.

showFeaturedstring

Whether to show featured users in the organization. Featured users are randomly selected from the organization members.

If not provided, featuredUsers will not be included in the response.

pageinteger

Page number (starts from 1).

page_sizeinteger

Entries per page.

Response

A list of organizations.

tenantIdstring required
idstring required
namestring required
descriptionstring nullable required
customDataobject required

arbitrary

isMfaRequiredboolean required
isTrustedDeviceAllowedboolean required
customCssstring nullable required
createdAtnumber required
usersCountnumber

Changes

  • f6be196bc327Revision changes
    • breaking

      the /// response property's maxLength was increased from 12 to 128 for the response status

  • 5768a9ce87dbRevision changes
    • info

      added the required property / to the response with the status