Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
IAM Reseller Clients

Get clients

get/iam/clients

Query parameters

limitinteger

The maximum number of items.

offsetinteger

Offset relative to the beginning of list.

orderingstring
Example:email,-created

The parameter using for sorting data.

Default sort order is ascending. Put - before value for descending sort order: -id.

For sorting by multiple parameters write them as comma separated string: id,-status.

  • id sort by client's ID.
  • email sort by client's email.
  • name sort by client's name.
  • status sort by client's status.
  • companyName sort by client's company name.
  • created_at sort by client's created datetime.

Use comma separated string for multiple-field sorting.

emailstring email

Filter byemail address.

companyNamestring

Filter by client's company name.

namestring

Filter by client's name.

deleted'true' | 'false'

Filter by status of deletion:

  • true — only deleted;
  • false — only non-deleted clients;
  • other value — return all.
reseller_idinteger

Filter by reseller ID.

seller_idinteger

Filter by seller ID.

custom_idstring

Filter by client's custom ID.

cdn'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted'

Status of the service.

Filter by CDN service status.

storage'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted'

Status of the service.

Filter by Storage service status.

ddos'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted'

Status of the service.

Filter by DDOS service status.

dns'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted'

Status of the service.

Filter by DNS service status.

cloud'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted'

Status of the service.

Filter by CLOUD service status.

infrastructure_protection'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted'

Status of the service.

Filter by Infrastructure Protection service status.

connect'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted'

Status of the service.

Filter by Connect service status.

min_trafficnumber

Filter by allowed traffic volume (GB).

max_trafficnumber

Filter by allowed traffic volume (GB).

secondaryhostnamesstring

Filter by name of secondary hostnames.

activatedtrue | false

Filter by status of activation:

  • true - activated;
  • false - non-activated.
id__in__excludestring

Exclude clients with these IDs.

Use comma separated string for multiple values.

bill_typestring

Filter by bill type.

users_namestring

Filter by users name.

users_emailstring

Filter by users email.

created_at_gtestring date-time

Filter all client's that created after this date.

created_at_ltestring date-time

Filter all client's that created before this date.

feature_id_instring

Filter by feature ids.

is_testtrue | false

Filter test clients:

  • true - only test clients;
  • false - only non-test clients.
client_type'reseller' | 'sales' | 'common'

Filter by client's type.

personal_product_availabilitystring

Filter clients with enabled personal availability on specific products.

Use comma separated string for multiple values.

promocodestring

Filter by promocode.

country_codestring

Filter by country (ISO 3166-1 alpha-2 format).

null - to get clients without country code.

Response

OK.

OR

Example response

[
  {
    "users": [
      {
        "groups": [
          {
            "id": 1,
            "name": "Administrators"
          }
        ]
      }
    ],
    "paidFeatures": {
      "CDN": [
        {
          "feature_id": 1,
          "name": "paid feature name",
          "service": "CDN"
        }
      ],
      "STREAMING": [
        {
          "feature_id": 2,
          "name": "another paid feature name",
          "service": "STREAMING"
        }
      ]
    },
    "freeFeatures": {
      "CDN": [
        {
          "feature_id": 1,
          "name": "free feature name",
          "service": "CDN"
        }
      ],
      "STREAMING": [
        {
          "feature_id": 2,
          "name": "another free feature name",
          "service": "STREAMING"
        }
      ]
    }
  }
]