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

# List dealers

`GET /dealers`

List a collection of dealers.

## Response `200`

OK

- object
  - `count` integer — Total number of resource.
  - `items` object[]
    - `id` string — The unique ID of the resource.
    - `enabled` boolean — Enable this dealer or not.
    - `level` 'DISTRIBUTOR' | 'SUB_DISTRIBUTOR' | 'RESELLER' — Dealer level includes: - `DISTRIBUTOR`: the first level of dealers. - `SUB_DISTRIBUTOR`: the second level of dealers. - `RESELLER`: the third level of dealers.
    - `name` string — The user's account name. Only letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .). Username cannot start or end with period (.). `admin`, `system`, `administrator`, and `root` are reserved names for system admin only with case ignored.
    - `email` string — The email address.
    - `display_name` string — The display name of user.
    - `website` string — The website of user.
    - `phone` string — The mobile phone number of user.
    - `address` string — The address.
    - `description` string — The description of dealer.
    - `max_tenants` integer — The maximum number of tenants that the dealer is allowed to create.
    - `max_extensions` integer — The maximum number of extensions that the dealer is allowed to create.
    - `tenant_full_access` boolean — Whether or not the reseller is allowed to have full control over the tenant. This attribute is not valid if not modified by first level dealer.

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