> ## Documentation Index
> Fetch the complete documentation index at: https://gcore.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get clients



## OpenAPI

````yaml /api-reference/services_documented/iam_reseller_api.yaml get /iam/clients
openapi: 3.1.0
info:
  title: Gcore OpenAPI – IAM Reseller API
  description: >-
    This OpenAPI is an aggregated OpenAPI specification that unifies all Gcore
    products into a single file. It covers Cloud, CDN, DNS, WAAP, DDoS
    Protection, Object Storage, Streaming, and FastEdge services.
  version: '2026-05-11T15:10:30.328297+00:00'
servers:
  - url: https://api.gcore.com
security:
  - APIKey: []
tags:
  - name: IAM Reseller Account
    description: >-
      Account management operations including authentication, password
      management, and account details.
    x-displayName: Account
  - name: IAM Reseller Clients
    description: >-
      Clients management API.


      Note: For client's creation use [create a new
      user](#tag/Users/paths/~1users/post) method from Users management API.
    x-displayName: Clients
  - name: IAM Reseller Users
    description: Client's users management API.
    x-displayName: Users
  - name: Sellers
    description: Seller management API.
    x-displayName: Sellers
  - name: Products' availability
    description: >-
      As a reseller you can get access to multiple products that available for
      you. Such as CDN.


      With this API you can manage which products are available for you clients
      by default or manage personal

      products' availability for each client separately.
    x-displayName: Products' availability
  - name: Services
    description: Client services management API for managing service statuses and options.
    x-displayName: Services
  - name: IAM Reseller Features
    description: You can manage both free and paid features available for you.
    x-displayName: Features
  - name: Branding
    description: >-
      Branding settings management API for customizing reseller branding
      including logos, colors, and domain settings.
    x-displayName: Branding
  - name: Notification Settings
    description: Notification settings which not connected with branding
    x-displayName: Notification Settings
  - name: Other
    x-displayName: Other
paths:
  /iam/clients:
    get:
      tags:
        - IAM Reseller Clients
      summary: Get clients
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
        - $ref: '#/components/parameters/ClientsOrdering'
        - $ref: '#/components/parameters/FilterByEmailAddress'
        - $ref: '#/components/parameters/FilterClientsByCompanyName'
        - $ref: '#/components/parameters/FilterClientsByName'
        - $ref: '#/components/parameters/FilterByDeleted'
        - $ref: '#/components/parameters/FilterClientsByResellerID'
        - $ref: '#/components/parameters/FilterClientsBySellerID'
        - $ref: '#/components/parameters/FilterClientsByCustomID'
        - $ref: '#/components/parameters/FilterClientsByCDNStatus'
        - $ref: '#/components/parameters/FilterClientsByStorageStatus'
        - $ref: '#/components/parameters/FilterClientsByDDOSStatus'
        - $ref: '#/components/parameters/FilterClientsByDNSStatus'
        - $ref: '#/components/parameters/FilterClientsByCLOUDStatus'
        - $ref: >-
            #/components/parameters/FilterClientsByInfrastructureProtectionStatus
        - $ref: '#/components/parameters/FilterClientsByConnectStatus'
        - $ref: '#/components/parameters/FilterClientsByMinTraffic'
        - $ref: '#/components/parameters/FilterClientsByMaxTraffic'
        - $ref: '#/components/parameters/FilterClientsBySecondaryHostnames'
        - $ref: '#/components/parameters/FilterByActivated'
        - $ref: '#/components/parameters/FilterClientsByExcludeByID'
        - $ref: '#/components/parameters/FilterClientsByBillType'
        - $ref: '#/components/parameters/FilterClientsByUsersName'
        - $ref: '#/components/parameters/FilterClientsByUsersEmail'
        - $ref: '#/components/parameters/FilterClientsByCreatedGte'
        - $ref: '#/components/parameters/FilterClientsByCreatedLte'
        - $ref: '#/components/parameters/FilterClientsByFeatureId'
        - $ref: '#/components/parameters/FilterClientsByIsTest'
        - $ref: '#/components/parameters/FilterClientsByClientType'
        - $ref: '#/components/parameters/FilterClientsByPersonalProductAvailability'
        - $ref: '#/components/parameters/FilterClientsByPromoCode'
        - $ref: '#/components/parameters/FilterClientsByCountryCode'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClientsResponse'
        '401':
          $ref: '#/components/responses/401'
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: The maximum number of items.
      schema:
        type: integer
    Offset:
      name: offset
      in: query
      description: Offset relative to the beginning of list.
      schema:
        type: integer
    ClientsOrdering:
      name: ordering
      in: query
      description: >-
        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.
      schema:
        type: string
        example: email,-created
    FilterByEmailAddress:
      name: email
      in: query
      description: Filter byemail address.
      schema:
        type: string
        format: email
    FilterClientsByCompanyName:
      name: companyName
      in: query
      description: Filter by client's company name.
      schema:
        type: string
    FilterClientsByName:
      name: name
      in: query
      description: Filter by client's name.
      schema:
        type: string
    FilterByDeleted:
      name: deleted
      in: query
      description: |-
        Filter by status of deletion:
        - `true` — only deleted;
        - `false` — only non-deleted clients;
        - other value — return all.
      schema:
        type: string
        enum:
          - 'true'
          - 'false'
    FilterClientsByResellerID:
      name: reseller_id
      in: query
      description: Filter by reseller ID.
      schema:
        type: integer
    FilterClientsBySellerID:
      name: seller_id
      in: query
      description: Filter by seller ID.
      schema:
        type: integer
    FilterClientsByCustomID:
      name: custom_id
      in: query
      description: Filter by client's custom ID.
      schema:
        type: string
    FilterClientsByCDNStatus:
      name: cdn
      in: query
      description: Filter by CDN service status.
      schema:
        $ref: '#/components/schemas/ServiceStatus'
    FilterClientsByStorageStatus:
      name: storage
      in: query
      description: Filter by Storage service status.
      schema:
        $ref: '#/components/schemas/ServiceStatus'
    FilterClientsByDDOSStatus:
      name: ddos
      in: query
      description: Filter by DDOS service status.
      schema:
        $ref: '#/components/schemas/ServiceStatus'
    FilterClientsByDNSStatus:
      name: dns
      in: query
      description: Filter by DNS service status.
      schema:
        $ref: '#/components/schemas/ServiceStatus'
    FilterClientsByCLOUDStatus:
      name: cloud
      in: query
      description: Filter by CLOUD service status.
      schema:
        $ref: '#/components/schemas/ServiceStatus'
    FilterClientsByInfrastructureProtectionStatus:
      name: infrastructure_protection
      in: query
      description: Filter by Infrastructure Protection service status.
      schema:
        $ref: '#/components/schemas/ServiceStatus'
    FilterClientsByConnectStatus:
      name: connect
      in: query
      description: Filter by Connect service status.
      schema:
        $ref: '#/components/schemas/ServiceStatus'
    FilterClientsByMinTraffic:
      name: min_traffic
      in: query
      description: Filter by allowed traffic volume (GB).
      schema:
        type: number
    FilterClientsByMaxTraffic:
      name: max_traffic
      in: query
      description: Filter by allowed traffic volume (GB).
      schema:
        type: number
    FilterClientsBySecondaryHostnames:
      name: secondaryhostnames
      in: query
      schema:
        type: string
      description: Filter by name of secondary hostnames.
    FilterByActivated:
      name: activated
      in: query
      description: |-
        Filter by status of activation:
        - `true` - activated;
        - `false` - non-activated.
      schema:
        type: boolean
        enum:
          - true
          - false
    FilterClientsByExcludeByID:
      name: id__in__exclude
      in: query
      description: |-
        Exclude clients with these IDs.

        Use comma separated string for multiple values.
      schema:
        type: string
    FilterClientsByBillType:
      name: bill_type
      in: query
      description: Filter by bill type.
      schema:
        type: string
    FilterClientsByUsersName:
      name: users_name
      in: query
      description: Filter by users name.
      schema:
        type: string
    FilterClientsByUsersEmail:
      name: users_email
      in: query
      description: Filter by users email.
      schema:
        type: string
    FilterClientsByCreatedGte:
      name: created_at_gte
      in: query
      description: Filter all client's that created after this date.
      schema:
        type: string
        format: date-time
    FilterClientsByCreatedLte:
      name: created_at_lte
      in: query
      description: Filter all client's that created before this date.
      schema:
        type: string
        format: date-time
    FilterClientsByFeatureId:
      name: feature_id_in
      in: query
      description: Filter by feature ids.
      schema:
        type: string
    FilterClientsByIsTest:
      name: is_test
      in: query
      description: |-
        Filter test clients:
        - `true` - only test clients;
        - `false` - only non-test clients.
      schema:
        type: boolean
        enum:
          - true
          - false
    FilterClientsByClientType:
      name: client_type
      in: query
      description: Filter by client's type.
      schema:
        type: string
        enum:
          - reseller
          - sales
          - common
    FilterClientsByPersonalProductAvailability:
      name: personal_product_availability
      in: query
      description: |-
        Filter clients with enabled personal availability on specific products.

        Use comma separated string for multiple values.
      schema:
        type: string
    FilterClientsByPromoCode:
      name: promocode
      in: query
      description: Filter by promocode.
      schema:
        type: string
    FilterClientsByCountryCode:
      name: country_code
      in: query
      description: |-
        Filter by country (ISO 3166-1 alpha-2 format).

        `null` - to get clients without country code.
      schema:
        type: string
  schemas:
    GetClientsResponse:
      oneOf:
        - $ref: '#/components/schemas/ClientsArray'
        - $ref: '#/components/schemas/ClientsPaginatedArray'
    ServiceStatus:
      type: string
      description: Status of the service.
      enum:
        - new
        - trial
        - trialend
        - active
        - paused
        - activating
        - deleted
    ClientsArray:
      allOf:
        - $ref: '#/components/schemas/ItemsArray'
        - items:
            $ref: '#/components/schemas/Client'
    ClientsPaginatedArray:
      allOf:
        - $ref: '#/components/schemas/PaginatedItemsArray'
        - type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/Client'
    ItemsArray:
      type: array
      description: Simple array without pagination
      items:
        type: object
    Client:
      allOf:
        - $ref: '#/components/schemas/iam_reseller_ClientBase'
        - type: object
          properties:
            seller:
              $ref: '#/components/schemas/ClientSeller'
            resellers:
              $ref: '#/components/schemas/ClientReseller'
            client_type:
              $ref: '#/components/schemas/ClientType'
            owner:
              $ref: '#/components/schemas/ClientOwner'
    PaginatedItemsArray:
      type: object
      properties:
        count:
          type: number
          description: Total number of users
        next:
          type: string
          description: URL to the next users slice
          example: /users?offset=20&limit=10
        previous:
          type: string
          description: URL to the previous users slice
          example: /users?offset=10&limit=10
        results:
          type: array
          items:
            type: object
    iam_reseller_ClientBase:
      type: object
      required:
        - id
        - email
        - name
        - status
        - companyName
        - deleted
        - is_test
        - has_active_admin
        - currentUser
        - capabilities
        - serviceStatuses
        - paidFeatures
        - freeFeatures
        - entryBaseDomain
        - bill_type
      properties:
        id:
          type: integer
          description: The account ID.
        users:
          type: array
          description: List of account users.
          items:
            $ref: '#/components/schemas/iam_reseller_BaseUser'
        email:
          $ref: '#/components/schemas/ClientEmail'
        phone:
          $ref: '#/components/schemas/ClientPhone'
        name:
          $ref: '#/components/schemas/ClientName'
        status:
          $ref: '#/components/schemas/ClientStatus'
        companyName:
          $ref: '#/components/schemas/ClientCompanyName'
        website:
          $ref: '#/components/schemas/ClientWebsite'
        currentUser:
          $ref: '#/components/schemas/CurrentUser'
        capabilities:
          $ref: '#/components/schemas/ClientCapabilities'
        serviceStatuses:
          $ref: '#/components/schemas/ServiceEnabledStatusObject'
        paidFeatures:
          $ref: '#/components/schemas/PaidFeatureList'
        freeFeatures:
          $ref: '#/components/schemas/FreeFeatureList'
        entryBaseDomain:
          $ref: '#/components/schemas/ClientEntryBaseDomain'
        signup_process:
          $ref: '#/components/schemas/SignupProcess'
        deleted:
          $ref: '#/components/schemas/Deleted-2'
        bill_type:
          $ref: '#/components/schemas/ClientBillType'
        custom_id:
          $ref: '#/components/schemas/ClientCustomID'
        country_code:
          $ref: '#/components/schemas/ClientCountryCode'
        is_test:
          $ref: '#/components/schemas/ClientIsTest'
        has_active_admin:
          $ref: '#/components/schemas/ClientHasActiveUser'
    ClientSeller:
      type: integer
      nullable: true
      description: ID of the Seller.
    ClientReseller:
      type: integer
      description: ID of the Reseller.
    ClientType:
      type: string
      description: Client's type.
      enum:
        - common
        - reseller
        - sales
    ClientOwner:
      type: number
      description: Id of the user, who created client.
    iam_reseller_BaseUser:
      type: object
      properties:
        id:
          type: integer
          description: User's ID.
          readOnly: true
        email:
          $ref: '#/components/schemas/UserEmail'
        name:
          $ref: '#/components/schemas/UserName'
        lang:
          $ref: '#/components/schemas/Language-2'
        phone:
          $ref: '#/components/schemas/UserPhone'
        company:
          $ref: '#/components/schemas/UserCompany'
        reseller:
          type: integer
          description: Services provider ID.
          readOnly: true
        client:
          type: number
          description: User's account ID.
          readOnly: true
        deleted:
          type: boolean
          description: Deletion flag. If `true` then user was deleted.
          readOnly: true
        groups:
          $ref: '#/components/schemas/UserGroups'
        activated:
          type: boolean
          description: |-
            Email confirmation:
            - `true` – user confirmed the email;
            - `false` – user did not confirm the email.
          readOnly: true
        sso_auth:
          type: boolean
          description: SSO authentication flag. If `true` then user can login via SAML SSO.
          readOnly: true
        two_fa:
          type: boolean
          description: |-
            Two-step verification:
            - `true` – user enabled two-step verification;
            - `false` – user disabled two-step verification.
          readOnly: true
        auth_types:
          $ref: '#/components/schemas/AuthTypes'
    ClientEmail:
      type: string
      format: email
      description: The account email.
    ClientPhone:
      type: string
      description: Phone of a user who registered the requested account.
      nullable: true
    ClientName:
      type: string
      description: Name of a user who registered the requested account.
      nullable: true
    ClientStatus:
      type: string
      description: Status of the account.
      enum:
        - new
        - trial
        - trialend
        - active
        - integration
        - paused
        - preparation
        - ready
    ClientCompanyName:
      type: string
      description: The company name.
    ClientWebsite:
      type: string
      description: The company website.
    CurrentUser:
      type: integer
      description: ID of the current user.
    ClientCapabilities:
      type: array
      items:
        $ref: '#/components/schemas/ServiceName'
      description: System field. List of services available for the account.
    ServiceEnabledStatusObject:
      type: object
      description: >-
        An object of arrays which contains information about all services
        available for the requested account.
      properties:
        CDN:
          $ref: '#/components/schemas/ServiceEnabledStatus'
        CLOUD:
          $ref: '#/components/schemas/ServiceEnabledStatus'
        DDOS:
          $ref: '#/components/schemas/ServiceEnabledStatus'
        DNS:
          $ref: '#/components/schemas/ServiceEnabledStatus'
        STORAGE:
          $ref: '#/components/schemas/ServiceEnabledStatus'
        STREAMING:
          $ref: '#/components/schemas/ServiceEnabledStatus'
    PaidFeatureList:
      type: object
      description: >-
        An object of arrays which contains information about paid features
        available for the requested account.
      properties:
        CDN:
          type: array
          items:
            $ref: '#/components/schemas/PaidFeature'
        CLOUD:
          type: array
          items:
            $ref: '#/components/schemas/PaidFeature'
        DDOS:
          type: array
          items:
            $ref: '#/components/schemas/PaidFeature'
        DNS:
          type: array
          items:
            $ref: '#/components/schemas/PaidFeature'
        STORAGE:
          type: array
          items:
            $ref: '#/components/schemas/PaidFeature'
        STREAMING:
          type: array
          items:
            $ref: '#/components/schemas/PaidFeature'
      example:
        CDN:
          - feature_id: 1
            name: paid feature name
            service: CDN
        STREAMING:
          - feature_id: 2
            name: another paid feature name
            service: STREAMING
    FreeFeatureList:
      type: object
      description: >-
        An object of arrays which contains information about free features
        available for the requested account.
      properties:
        CDN:
          type: array
          items:
            $ref: '#/components/schemas/FreeFeature'
        CLOUD:
          type: array
          items:
            $ref: '#/components/schemas/FreeFeature'
        DDOS:
          type: array
          items:
            $ref: '#/components/schemas/FreeFeature'
        DNS:
          type: array
          items:
            $ref: '#/components/schemas/FreeFeature'
        STORAGE:
          type: array
          items:
            $ref: '#/components/schemas/FreeFeature'
        STREAMING:
          type: array
          items:
            $ref: '#/components/schemas/FreeFeature'
      example:
        CDN:
          - feature_id: 1
            name: free feature name
            service: CDN
        STREAMING:
          - feature_id: 2
            name: another free feature name
            service: STREAMING
    ClientEntryBaseDomain:
      type: string
      nullable: true
      description: System field. Control panel domain.
    SignupProcess:
      type: string
      nullable: true
      description: System field. Type of the account registration process.
      enum:
        - sign_up_full
        - sign_up_simple
    Deleted-2:
      type: boolean
      description: |-
        The field shows the status of the account:
        - `true` – the account has been deleted
        - `false` – the account is not deleted
      readOnly: true
    ClientBillType:
      type: string
      description: System field. Billing type of the account.
    ClientCustomID:
      type: string
      nullable: true
      description: The account custom ID.
    ClientCountryCode:
      type: string
      description: System field. The company country (ISO 3166-1 alpha-2 format).
    ClientIsTest:
      type: boolean
      description: |-
        System field:
        - `true` — a test account;
        - `false` — a production account.
    ClientHasActiveUser:
      type: boolean
      description: System field.
    UserEmail:
      type: string
      format: email
      description: User's email address.
    UserName:
      type: string
      description: User's name.
      nullable: true
    Language-2:
      type: string
      description: |-
        User's language.

        Defines language of the control panel and email messages.
      enum:
        - de
        - en
        - ru
        - zh
        - az
    UserPhone:
      type: string
      description: User's phone.
      nullable: true
    UserCompany:
      type: string
      description: User's company.
    UserGroups:
      type: array
      description: |-
        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)
      items:
        $ref: '#/components/schemas/Group'
    AuthTypes:
      type: array
      items:
        $ref: '#/components/schemas/AuthType'
      description: System field. List of auth types available for the account.
    ServiceName:
      type: string
      description: Service's name.
      enum:
        - CDN
        - STORAGE
        - STREAMING
        - DNS
        - DDOS
        - CLOUD
    ServiceEnabledStatus:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ServiceStatus'
        enabled:
          type: boolean
          description: '`true` - service is available in the Control Panel.'
    PaidFeature:
      type: object
      description: Feature object.
      properties:
        feature_id:
          type: integer
          description: Feature ID.
        service:
          allOf:
            - description: Name of a service which the feature belongs to.
            - $ref: '#/components/schemas/ServiceName'
        name:
          type: string
          description: Name of the feature.
        create_date:
          type: string
          description: >-
            Date and time when the feature was activated (ISO 8086/RFC 3339
            format).
        paid_feature_id:
          type: integer
          description: Internal feature activation ID.
    FreeFeature:
      type: object
      description: Feature object.
      properties:
        feature_id:
          type: integer
          description: Feature ID.
        service:
          allOf:
            - description: Name of a service which the feature belongs to.
            - $ref: '#/components/schemas/ServiceName'
        name:
          type: string
          description: Name of the feature.
        create_date:
          type: string
          description: >-
            Date and time when the feature was activated (ISO 8086/RFC 3339
            format).
        free_feature_id:
          type: integer
          description: Internal feature activation ID.
    Group:
      type: object
      properties:
        id:
          type: integer
          example: 1
          description: >-
            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:
          type: string
          example: Administrators
          description: Group's name.
          enum:
            - Users
            - Administrators
            - Engineers
            - Purge and Prefetch only (API)
            - Purge and Prefetch only (API+Web)
    AuthType:
      type: string
      description: Auth types.
      enum:
        - password
        - sso
        - github
        - google-oauth2
  responses:
    '401':
      description: >-
        Authentication credentials were not provided or given token not valid
        for any token type.
  securitySchemes:
    APIKey:
      description: >-
        API key for authentication. Make sure to include the word `apikey`,
        followed by a single space and then your token.

        Example: `apikey 1234$abcdef`
      type: apiKey
      in: header
      name: Authorization

````