---
title: "Retrieve current tenant status"
method: GET
path: "/tenant/status"
tags: ["Tenant"]
---

# Retrieve current tenant status

`GET /tenant/status`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/tenant/status`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/tenant/status/get.ts> (a function with typed inputs; its response is checked against the schema)

Get status of current tenant.

## Response `200`

OK

- object
  - `version` string: The version information of PortSIP PBX.
  - `licensed_users` integer: The maximum number of authorized users purchased by the tenant from System Admin or Dealer.
  - `current_users` integer: The number of current users of the tenant.
  - `online_users` integer: The number of current online users of the tenant.
  - `current_calls` integer: The current number of calls.
  - `current_queues` integer: The current number of call queues.
  - `current_conference_rooms` integer: The current number of conference rooms.
  - `current_ring_groups` integer: The current number of ring groups.
  - `current_ivrs` integer: The current number of virtual receptionists.
  - `current_trunks` integer: The current number of trunks.
  - `calls_in_24_hours` object[]
    - `time` 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
    - `count` integer: The number of calls at this time.

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)