---
title: "Retrieve current dealer status"
method: GET
path: "/dealer/status"
tags: ["Administration"]
---

# Retrieve current dealer status

`GET /dealer/status`

## Request

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

Get status of current dealer.

## Response `200`

OK

- object
  - `version` string: The version information of PortSIP PBX.
  - `max_dealers` integer: The maximum number of sub-dealers.
  - `current_dealers` integer: The number of current sub-dealers.
  - `max_users` integer: The maximum number of authorized users purchased by the dealer from distributor.
  - `current_users` integer: The number of current users of the dealer.
  - `max_tenants` integer: The maximum number of tenants the current dealer is allowed to create.
  - `current_tenants` integer: The number of current tenants of the dealer.

## 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)