Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Administration

Retrieve a dealer

Get details of the dealer by it's unique ID.

get/dealers/{id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the dealer.

Response

OK

idstring

The unique ID of the resource.

enabledboolean

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.
namestring

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.

emailstring

The email address.

display_namestring

The display name of user.

websitestring

The website of user.

phonestring

The mobile phone number of user.

addressstring

The address.

descriptionstring

The description of dealer.

max_tenantsinteger

The maximum number of tenants that the dealer is allowed to create.

max_extensionsinteger

The maximum number of extensions that the dealer is allowed to create.

tenant_full_accessboolean

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.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "email": "example@example.com"
}