# Get organizations

**GET /api/organizations**

Get organizations that match the given query with pagination.


## Servers
- Logto endpoint address.: https://[tenant_id].logto.app (Logto endpoint address.)


## Authentication methods
- O auth2


## Parameters


#### Query parameters
- **q** (string)
  The query to filter organizations. It can be a partial ID or name.

If not provided, all organizations will be returned.
- **showFeatured** (string)
  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.
- **page** (integer)
  Page number (starts from 1).
- **page_size** (integer)
  Entries per page.


## Responses
### 200: A list of organizations.

#### Body Parameters: application/json (array[object])
- **tenantId** (string)
  
- **id** (string)
  
- **name** (string)
  
- **description** (string | null)
  
- **customData** (object)
  arbitrary
- **isMfaRequired** (boolean)
  
- **color** (object)
  
- **branding** (object)
  
- **customCss** (string | null)
  
- **createdAt** (number)
  
- **usersCount** (number)
  
- **featuredUsers** (array[object])
  

### 400: Bad Request

### 401: Unauthorized

### 403: Forbidden


[Powered by Bump.sh](https://bump.sh)