--- title: "Get clients" method: GET path: "/iam/clients" tags: ["IAM Reseller Clients"] --- # Get clients `GET /iam/clients` ## Query parameters - `limit` integer - `offset` integer - `ordering` string - `email` string, email - `companyName` string - `name` string - `deleted` 'true' | 'false' - `reseller_id` integer - `seller_id` integer - `custom_id` string - `cdn` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `storage` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `ddos` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `dns` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `cloud` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `infrastructure_protection` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `connect` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `min_traffic` number - `max_traffic` number - `secondaryhostnames` string - `activated` true | false - `id__in__exclude` string - `bill_type` string - `users_name` string - `users_email` string - `created_at_gte` string, date-time - `created_at_lte` string, date-time - `feature_id_in` string - `is_test` true | false - `client_type` 'reseller' | 'sales' | 'common' - `personal_product_availability` string - `promocode` string - `country_code` string ## Response `200` OK. - union - object[] — Simple array without pagination - `id` integer, required — The account ID. - `users` IamResellerBaseUser[] — List of account users. - `id` integer — User's ID. - `email` string, email — User's email address. - `name` string, nullable — User's name. - `lang` 'de' | 'en' | 'ru' | 'zh' | 'az' — User's language. Defines language of the control panel and email messages. - `phone` string, nullable — User's phone. - `company` string — User's company. - `reseller` integer — Services provider ID. - `client` number — User's account ID. - `deleted` boolean — Deletion flag. If `true` then user was deleted. - `groups` Group[] — User's group in the current account. IAM supports 5 groups: - Users - Administrators - Engineers - Purge and Prefetch only (API) - Purge and Prefetch only (API+Web) - `id` integer — Group's ID: Possible values are: - 1 - Administrators* 2 - Users* 5 - Engineers* 3009 - Purge and Prefetch only (API+Web)* 3022 - Purge and Prefetch only (API) - `name` 'Users' | 'Administrators' | 'Engineers' | 'Purge and Prefetch only (API)' | 'Purge and Prefetch only (API+Web)' — Group's name. - `activated` boolean — Email confirmation: - `true` – user confirmed the email; - `false` – user did not confirm the email. - `sso_auth` boolean — SSO authentication flag. If `true` then user can login via SAML SSO. - `two_fa` boolean — Two-step verification: - `true` – user enabled two-step verification; - `false` – user disabled two-step verification. - `auth_types` AuthType[] — System field. List of auth types available for the account. - `email` string, email, required — The account email. - `phone` string, nullable — Phone of a user who registered the requested account. - `name` string, nullable, required — Name of a user who registered the requested account. - `status` 'new' | 'trial' | 'trialend' | 'active' | 'integration' | 'paused' | 'preparation' | 'ready', required — Status of the account. - `companyName` string, required — The company name. - `website` string — The company website. - `currentUser` integer, required — ID of the current user. - `capabilities` ServiceName[], required — System field. List of services available for the account. - `serviceStatuses` ServiceEnabledStatusObject, required — An object of arrays which contains information about all services available for the requested account. - `CDN` ServiceEnabledStatus - `status` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `enabled` boolean — `true` - service is available in the Control Panel. - `CLOUD` ServiceEnabledStatus - `status` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `enabled` boolean — `true` - service is available in the Control Panel. - `DDOS` ServiceEnabledStatus - `status` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `enabled` boolean — `true` - service is available in the Control Panel. - `DNS` ServiceEnabledStatus - `status` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `enabled` boolean — `true` - service is available in the Control Panel. - `STORAGE` ServiceEnabledStatus - `status` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `enabled` boolean — `true` - service is available in the Control Panel. - `STREAMING` ServiceEnabledStatus - `status` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `enabled` boolean — `true` - service is available in the Control Panel. - `paidFeatures` PaidFeatureList, required — An object of arrays which contains information about paid features available for the requested account. - `CDN` PaidFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `paid_feature_id` integer — Internal feature activation ID. - `CLOUD` PaidFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `paid_feature_id` integer — Internal feature activation ID. - `DDOS` PaidFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `paid_feature_id` integer — Internal feature activation ID. - `DNS` PaidFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `paid_feature_id` integer — Internal feature activation ID. - `STORAGE` PaidFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `paid_feature_id` integer — Internal feature activation ID. - `STREAMING` PaidFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `paid_feature_id` integer — Internal feature activation ID. - `freeFeatures` FreeFeatureList, required — An object of arrays which contains information about free features available for the requested account. - `CDN` FreeFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `free_feature_id` integer — Internal feature activation ID. - `CLOUD` FreeFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `free_feature_id` integer — Internal feature activation ID. - `DDOS` FreeFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `free_feature_id` integer — Internal feature activation ID. - `DNS` FreeFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `free_feature_id` integer — Internal feature activation ID. - `STORAGE` FreeFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `free_feature_id` integer — Internal feature activation ID. - `STREAMING` FreeFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `free_feature_id` integer — Internal feature activation ID. - `entryBaseDomain` string, nullable, required — System field. Control panel domain. - `signup_process` 'sign_up_full' | 'sign_up_simple', nullable — System field. Type of the account registration process. - `deleted` boolean, required — The field shows the status of the account: - `true` – the account has been deleted - `false` – the account is not deleted - `bill_type` string, required — System field. Billing type of the account. - `custom_id` string, nullable — The account custom ID. - `country_code` string — System field. The company country (ISO 3166-1 alpha-2 format). - `is_test` boolean, required — System field: - `true` — a test account; - `false` — a production account. - `has_active_admin` boolean, required — System field. - `seller` integer, nullable — ID of the Seller. - `resellers` integer — ID of the Reseller. - `client_type` 'common' | 'reseller' | 'sales' — Client's type. - `owner` number — Id of the user, who created client. - ClientsPaginatedArray - `count` number — Total number of users - `next` string — URL to the next users slice - `previous` string — URL to the previous users slice - `results` object[] - `id` integer, required — The account ID. - `users` IamResellerBaseUser[] — List of account users. - `id` integer — User's ID. - `email` string, email — User's email address. - `name` string, nullable — User's name. - `lang` 'de' | 'en' | 'ru' | 'zh' | 'az' — User's language. Defines language of the control panel and email messages. - `phone` string, nullable — User's phone. - `company` string — User's company. - `reseller` integer — Services provider ID. - `client` number — User's account ID. - `deleted` boolean — Deletion flag. If `true` then user was deleted. - `groups` Group[] — User's group in the current account. IAM supports 5 groups: - Users - Administrators - Engineers - Purge and Prefetch only (API) - Purge and Prefetch only (API+Web) - `id` integer — Group's ID: Possible values are: - 1 - Administrators* 2 - Users* 5 - Engineers* 3009 - Purge and Prefetch only (API+Web)* 3022 - Purge and Prefetch only (API) - `name` 'Users' | 'Administrators' | 'Engineers' | 'Purge and Prefetch only (API)' | 'Purge and Prefetch only (API+Web)' — Group's name. - `activated` boolean — Email confirmation: - `true` – user confirmed the email; - `false` – user did not confirm the email. - `sso_auth` boolean — SSO authentication flag. If `true` then user can login via SAML SSO. - `two_fa` boolean — Two-step verification: - `true` – user enabled two-step verification; - `false` – user disabled two-step verification. - `auth_types` AuthType[] — System field. List of auth types available for the account. - `email` string, email, required — The account email. - `phone` string, nullable — Phone of a user who registered the requested account. - `name` string, nullable, required — Name of a user who registered the requested account. - `status` 'new' | 'trial' | 'trialend' | 'active' | 'integration' | 'paused' | 'preparation' | 'ready', required — Status of the account. - `companyName` string, required — The company name. - `website` string — The company website. - `currentUser` integer, required — ID of the current user. - `capabilities` ServiceName[], required — System field. List of services available for the account. - `serviceStatuses` ServiceEnabledStatusObject, required — An object of arrays which contains information about all services available for the requested account. - `CDN` ServiceEnabledStatus - `status` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `enabled` boolean — `true` - service is available in the Control Panel. - `CLOUD` ServiceEnabledStatus - `status` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `enabled` boolean — `true` - service is available in the Control Panel. - `DDOS` ServiceEnabledStatus - `status` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `enabled` boolean — `true` - service is available in the Control Panel. - `DNS` ServiceEnabledStatus - `status` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `enabled` boolean — `true` - service is available in the Control Panel. - `STORAGE` ServiceEnabledStatus - `status` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `enabled` boolean — `true` - service is available in the Control Panel. - `STREAMING` ServiceEnabledStatus - `status` 'new' | 'trial' | 'trialend' | 'active' | 'paused' | 'activating' | 'deleted' — Status of the service. - `enabled` boolean — `true` - service is available in the Control Panel. - `paidFeatures` PaidFeatureList, required — An object of arrays which contains information about paid features available for the requested account. - `CDN` PaidFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `paid_feature_id` integer — Internal feature activation ID. - `CLOUD` PaidFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `paid_feature_id` integer — Internal feature activation ID. - `DDOS` PaidFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `paid_feature_id` integer — Internal feature activation ID. - `DNS` PaidFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `paid_feature_id` integer — Internal feature activation ID. - `STORAGE` PaidFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `paid_feature_id` integer — Internal feature activation ID. - `STREAMING` PaidFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `paid_feature_id` integer — Internal feature activation ID. - `freeFeatures` FreeFeatureList, required — An object of arrays which contains information about free features available for the requested account. - `CDN` FreeFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `free_feature_id` integer — Internal feature activation ID. - `CLOUD` FreeFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `free_feature_id` integer — Internal feature activation ID. - `DDOS` FreeFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `free_feature_id` integer — Internal feature activation ID. - `DNS` FreeFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `free_feature_id` integer — Internal feature activation ID. - `STORAGE` FreeFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `free_feature_id` integer — Internal feature activation ID. - `STREAMING` FreeFeature[] - `feature_id` integer — Feature ID. - `service` 'CDN' | 'STORAGE' | 'STREAMING' | 'DNS' | 'DDOS' | 'CLOUD' — Service's name. - `name` string — Name of the feature. - `create_date` string — Date and time when the feature was activated (ISO 8086/RFC 3339 format). - `free_feature_id` integer — Internal feature activation ID. - `entryBaseDomain` string, nullable, required — System field. Control panel domain. - `signup_process` 'sign_up_full' | 'sign_up_simple', nullable — System field. Type of the account registration process. - `deleted` boolean, required — The field shows the status of the account: - `true` – the account has been deleted - `false` – the account is not deleted - `bill_type` string, required — System field. Billing type of the account. - `custom_id` string, nullable — The account custom ID. - `country_code` string — System field. The company country (ISO 3166-1 alpha-2 format). - `is_test` boolean, required — System field: - `true` — a test account; - `false` — a production account. - `has_active_admin` boolean, required — System field. - `seller` integer, nullable — ID of the Seller. - `resellers` integer — ID of the Reseller. - `client_type` 'common' | 'reseller' | 'sales' — Client's type. - `owner` number — Id of the user, who created client. ## Other responses - `401` — Authentication credentials were not provided or given token not valid for any token type. --- [API](https://skmtc.net/g-core/apis/gcore-openapi.md) · [All operations](https://skmtc.net/g-core/apis/gcore-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/g-core/gcore-openapi/revisions/09e652815095/schema)