---
title: "Tenant List"
method: GET
path: "/1/tenants"
tags: ["Tenant"]
---

# Tenant List

`GET /1/tenants`

## Request

- Base URL: `http://localhost:3000/api`
- URL: `http://localhost:3000/api/1/tenants`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/docs/1/tenants/get.ts> (a function with typed inputs; its response is checked against the schema)

List all tenants associated with the calling vendor organization.

## Query parameters

- `query` string
- `sortColumn` 'name' | 'id' | 'created' | 'updated'
- `status` 'accepted' | 'not-accepted' | 'archived'
- `sortDirection` 'asc' | 'desc'
- `pageSize` integer
- `page` integer

## Headers

- `icl-requestor-id` string, required

## Response `200`

Result of listing all tenants associated with the calling vendor.

- object
  - `result` TenantGetResponse[], required: Tenants
    - `id` string, required: Tenant ID
    - `name` string, required
    - `archived` boolean, required
    - `tenantCreatedConfigs` boolean, required
    - `invited` boolean, required: If true, this tenant has been invited, but not yet accepted their invitation.
    - `keyLeasingRequired` boolean, required: Whether key leasing must be enabled for all KMS configurations assigned to this tenant.
    - `primaryKmsConfigId` integer, nullable, required
    - `tags` Tag[], required
      - `id` integer, required: Tag ID
      - `tagText` string, required: Human-readable text associated with tag
      - `default` boolean, required: Whether this is the default tag for tenants/service accounts
      - `created` string, required: RFC3339 timestamp
    - `createdBy` CreatedBy, required: Metadata about creating user/service
      - `id` string, required: Creator ID
      - `name` string, required: Creator name
      - `type` 'Tsp' | 'Admin' | 'Va', required: Creator type
    - `created` string, required: RFC3339 timestamp
    - `updated` string, required: RFC3339 timestamp
  - `page` integer, required: Current response page number
  - `totalPages` integer, required: Total number of response pages

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge.md) - [All operations](https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/llms.txt) - [OpenAPI document](https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/revisions/5c0e553ffa21?raw)