---
title: "List tenant by paginating"
method: POST
path: "/inlong/manager/openapi/tenant/list"
tags: ["Open-InlongTenant-API"]
---

# List tenant by paginating

`POST /inlong/manager/openapi/tenant/list`

## Request

- The document declares no server URL.
- Auth: none declared

## Request body

- TenantPagingQueryRequest
  - `id` integer: Primary key
  - `keyword` string: Keyword
  - `listByLoginUser` boolean: Whether list tenant info of login user
  - `orderField` string: Order field, support create_time and modify_time, default is create_time
  - `orderType` string: Order type, only support asc and desc, default is desc
  - `pageNum` integer: Current page number, default is 1
  - `pageSize` integer: Page size, default is 10
  - `tenantList` string[]: Tenant list

## Response `200`

OK

- ResponsePaginatedQueryResultsInlongTenantInfo
  - `data` PaginatedQueryResultsInlongTenantInfo
    - `list` InlongTenantInfo[], required: data record
      - `createTime` string, date-time
      - `creator` string: Name of in creator
      - `description` string: Description of the tenant
      - `id` integer: Primary key
      - `modifier` string: Name of in modifier
      - `modifyTime` string, date-time
      - `name` string: Tenant name
      - `version` integer: Version number
    - `pageNum` integer, required: pageNum
    - `pageSize` integer, required: pageSize
    - `total` integer, required: The total number of items matching the filter criteria
  - `errMsg` string
  - `success` boolean

## Other responses

- `201`: Created
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/apache/apis/the-apache-software-foundation-file-api.md) - [All operations](https://skmtc.dev/apache/apis/the-apache-software-foundation-file-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apache/apis/the-apache-software-foundation-file-api/revisions/41c687f48683?raw)