---
title: "List all tenants"
method: GET
path: "/{spaceId}/tenants/all"
tags: ["Tenants"]
---

# List all tenants

`GET /{spaceId}/tenants/all`

## Request

- Base URL: `https://demo.octopus.app/api`
- URL: `https://demo.octopus.app/api/{spaceId}/tenants/all`
- Auth: one of:
  - API key in header `X-Octopus-ApiKey`
  - API key in query parameter `ApiKey`
  - API key in header `X-NuGet-ApiKey`

Lists all of the tenants in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.

## Path parameters

- `spaceId` string, required

## Query parameters

- `ids` string[]
- `isDisabled` boolean
- `name` string
- `partialName` string
- `projectId` string
- `tags` string[]

## Response `200`

Requested list of Tenants

- TenantResource[]
  - `ClonedFromTenantId` string
  - `CustomFields` string[]
  - `Description` string
  - `Icon` IconResource
    - `Color` string: Icon background colour, as a Hex string
    - `Id` string: Font Awesome Icon Id
  - `Id` string: Gets or sets a unique identifier for this resource.
  - `IsDisabled` boolean
  - `LastModifiedBy` string: Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time: Gets or sets the date/time that this resource was last modified.
  - `Links` object: Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  - `Name` string
  - `ProjectEnvironments` object
  - `Slug` string
  - `SpaceId` string
  - `TenantTags` string[]: Tags are referenced by CanonicalName like {TagSetName}/{TagName}

## Other responses

- `304`: Not Modified
- `400`: Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404`: Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.dev/octopus/apis/octopus-server-api.md) - [All operations](https://skmtc.dev/octopus/apis/octopus-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octopus/apis/octopus-server-api/revisions/fe937c07da34?raw)