# List tenants

Source: https://www.jawsdeploy.net/rest-api/tenants-list | Section: Tenants

List the tenants in a workspace.

`GET /api/tenant`

A tenant is one customer or site that your projects are deployed to. This lists the tenants of a workspace, sorted by name, each with its tags.

Archived tenants are left out unless you ask for them. Deleted tenants are never returned.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `workspaceId` | query | string | yes | ID of the workspace. |
| `includeArchived` | query | boolean | no | Set to `true` to include archived tenants. Defaults to `false`. |

## Errors

| Status | Meaning |
|---|---|
| 400 | Invalid `workspaceId`. |
| 401 | Missing or invalid Basic auth credentials, or the service account lacks permission to manage tenants in this workspace. |

Example request:

```
GET /api/tenant?workspaceId=ws_abc HTTP/1.1
Authorization: Basic <base64(serviceAccountId:apiKey)>
```

Example response:

```
{
  "workspaceId": "ws_abc",
  "tenants": [
    {
      "tenantId": "tnt_acme",
      "workspaceId": "ws_abc",
      "name": "Acme",
      "description": "Acme production site",
      "isArchived": false,
      "created": "2026-10-03T12:00:00+00:00",
      "tags": [
        { "tagId": "tag_eu", "name": "region:eu" }
      ]
    }
  ]
}
```