Get Tenants

Get list of tenants.

caution

This endpoint has been deprecated and will be phased out at the end of 2023. Please update any existing usages of it to use the List Objects endpoint instead.

Endpoint

GET /v1/tenants

Request

cURL

curl "https://api.warrant.dev/v1/tenants" \
    -H "Authorization: ApiKey YOUR_KEY"

Go

tenants, err := tenant.ListTenants(&warrant.ListTenantParams{
    ListParams: warrant.ListParams{
        Page:  1,
        Limit: 10,
    },
})
if err != nil {
    // handle error
}

Java

int limit = 10;
int page = 1;
Tenant[] tenants = client.listTenants(limit, page);

Node.js

warrantClient.User.list({ limit: 10, page: 1 });

Python

tenants = warrant.Tenant.list()

Ruby

tenants = Warrant::Tenant.list()

PHP

CLI

warrant list tenants

Response

[
  {
    "tenantId": "dunder-mifflin",
    "name": "Dunder Mifflin"
  },
  {
    "tenantId": "In2sgYSjVG8etPU2",
    "name": "tenant-name"
  },
  {
    "tenantId": "In2sgYSjcktPU235",
    "name": "tenant-name2"
  }
]