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

# List tenants

`GET /tenants`

Returns a list of tenant summary information.
Note that it uses a different, smaller representation of a tenant than retrieving a single tenant.

## Query parameters

- `filter` string
- `search` string
- `orderby` string
- `skip` integer
- `top` integer

## Response `200`

OK

- object
  - `count` integer — Total number of resource.
  - `items` object[]
    - `id` string — The unique ID of the resource.
    - `name` string — The name of the tenant.
    - `domain` string — The SIP domain of tenant. It is usually a fully qualified domain name (FQDN). If there is no FQDN, you can also use the IP address of the PBX server as the SIP domain. The SIP domain name is only used for SIP message authentication and does not require analysis.
    - `max_extensions` integer — The maximum number of users that the tenant is allowed to create.
    - `max_concurrent_calls` integer — The maximum number of concurrent calls that the tenant is allowed to have.
    - `enabled` boolean — Enable this tenant or not.
    - `website` string — The official website of tenant.
    - `timezone` string — The IANA Time Zone names, such as "Asia/Shanghai".
    - `currency` string — The Currency code (ISO 4217).
    - `region` string — A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html
    - `avatar_file_name` string — The name of the file.
    - `avatar_file_size` integer — The file size in bytes.
    - `avatar_file_url` string — The relative path to file url for file downloading.
    - `created_at` string, date_time — The RFC 3339 format is defined by The date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, 2017-07-21T17:32:28Z

## Other responses

- `4XX` — Error

---

[API](https://skmtc.net/portsip/apis/portsip-pbx-rest-api.md) · [All operations](https://skmtc.net/portsip/apis/portsip-pbx-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portsip/portsip-pbx-rest-api/revisions/577415d4a3d5/schema)