GET
/
iam
/
clients
Get clients
curl --request GET \
  --url https://api.gcore.com/iam/clients \
  --header 'Authorization: <api-key>'
[
  {
    "id": 123,
    "users": [
      {
        "id": 123,
        "email": "jsmith@example.com",
        "name": "<string>",
        "lang": "de",
        "phone": "<string>",
        "company": "<string>",
        "reseller": 123,
        "client": 123,
        "deleted": true,
        "groups": [
          {
            "id": 1,
            "name": "Administrators"
          }
        ],
        "activated": true,
        "sso_auth": true,
        "two_fa": true,
        "auth_types": [
          "password"
        ]
      }
    ],
    "email": "jsmith@example.com",
    "phone": "<string>",
    "name": "<string>",
    "status": "new",
    "companyName": "<string>",
    "website": "<string>",
    "currentUser": 123,
    "capabilities": [
      "CDN"
    ],
    "serviceStatuses": {
      "CDN": {
        "status": "new",
        "enabled": true
      },
      "CLOUD": {
        "status": "new",
        "enabled": true
      },
      "DDOS": {
        "status": "new",
        "enabled": true
      },
      "DNS": {
        "status": "new",
        "enabled": true
      },
      "STORAGE": {
        "status": "new",
        "enabled": true
      },
      "STREAMING": {
        "status": "new",
        "enabled": true
      }
    },
    "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"
        }
      ]
    },
    "entryBaseDomain": "<string>",
    "signup_process": "sign_up_full",
    "deleted": true,
    "bill_type": "<string>",
    "custom_id": "<string>",
    "country_code": "<string>",
    "is_test": true,
    "has_active_admin": true,
    "seller": 123,
    "resellers": 123,
    "client_type": "common",
    "owner": 123
  }
]

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

​
limit
integer

The maximum number of items.

​
offset
integer

Offset relative to the beginning of list.

​
ordering
string

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.

Example:

"email,-created"

​
email
string<email>

Filter byemail address.

​
companyName
string

Filter by client's company name.

​
name
string

Filter by client's name.

​
deleted
enum<string>

Filter by status of deletion:

  • true — only deleted;
  • false — only non-deleted clients;
  • other value — return all.
​
reseller_id
integer

Filter by reseller ID.

​
seller_id
integer

Filter by seller ID.

​
custom_id
string

Filter by client's custom ID.

​
cdn
enum<string>

Filter by CDN service status.

Available options:
new,
trial,
trialend,
active,
paused,
activating,
deleted
​
storage
enum<string>

Filter by Storage service status.

Available options:
new,
trial,
trialend,
active,
paused,
activating,
deleted
​
ddos
enum<string>

Filter by DDOS service status.

Available options:
new,
trial,
trialend,
active,
paused,
activating,
deleted
​
dns
enum<string>

Filter by DNS service status.

Available options:
new,
trial,
trialend,
active,
paused,
activating,
deleted
​
cloud
enum<string>

Filter by CLOUD service status.

Available options:
new,
trial,
trialend,
active,
paused,
activating,
deleted
​
infrastructure_protection
enum<string>

Filter by Infrastructure Protection service status.

Available options:
new,
trial,
trialend,
active,
paused,
activating,
deleted
​
connect
enum<string>

Filter by Connect service status.

Available options:
new,
trial,
trialend,
active,
paused,
activating,
deleted
​
min_traffic
number

Filter by allowed traffic volume (GB).

​
max_traffic
number

Filter by allowed traffic volume (GB).

​
secondaryhostnames
string

Filter by name of secondary hostnames.

​
activated
enum<string>

Filter by status of activation:

  • true - activated;
  • false - non-activated.
​
id__in__exclude
string

Exclude clients with these IDs.

Use comma separated string for multiple values.

​
bill_type
string

Filter by bill type.

​
users_name
string

Filter by users name.

​
users_email
string

Filter by users email.

​
created_at_gte
string<date-time>

Filter all client's that created after this date.

​
created_at_lte
string<date-time>

Filter all client's that created before this date.

​
feature_id_in
string

Filter by feature ids.

​
is_test
enum<string>

Filter test clients:

  • true - only test clients;
  • false - only non-test clients.
​
client_type
enum<string>

Filter by client's type.

Available options:
reseller,
sales,
common
​
personal_product_availability
string

Filter clients with enabled personal availability on specific products.

Use comma separated string for multiple values.

​
promocode
string

Filter by promocode.

​
country_code
string

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

null - to get clients without country code.

Response

OK.

Simple array without pagination

​
id
integer

The account ID.

​
users
object[]

List of account users.

​
email
string<email>

The account email.

​
phone
string | null

Phone of a user who registered the requested account.

​
name
string | null

Name of a user who registered the requested account.

​
status
enum<string>

Status of the account.

Available options:
new,
trial,
trialend,
active,
integration,
paused,
preparation,
ready
​
companyName
string

The company name.

​
website
string

The company website.

​
currentUser
integer

ID of the current user.

​
capabilities
enum<string>[]

System field. List of services available for the account.

​
serviceStatuses
object

An object of arrays which contains information about all services available for the requested account.

​
paidFeatures
object

An object of arrays which contains information about paid features available for the requested account.

Example:
{
  "CDN": [
    {
      "feature_id": 1,
      "name": "paid feature name",
      "service": "CDN"
    }
  ],
  "STREAMING": [
    {
      "feature_id": 2,
      "name": "another paid feature name",
      "service": "STREAMING"
    }
  ]
}
​
freeFeatures
object

An object of arrays which contains information about free features available for the requested account.

Example:
{
  "CDN": [
    {
      "feature_id": 1,
      "name": "free feature name",
      "service": "CDN"
    }
  ],
  "STREAMING": [
    {
      "feature_id": 2,
      "name": "another free feature name",
      "service": "STREAMING"
    }
  ]
}
​
entryBaseDomain
string | null

System field. Control panel domain.

​
signup_process
enum<string> | null

System field. Type of the account registration process.

Available options:
sign_up_full,
sign_up_simple
​
deleted
boolean

The field shows the status of the account:

  • true – the account has been deleted
  • false – the account is not deleted
​
bill_type
string

System field. Billing type of the account.

​
custom_id
string | null

The account custom ID.

​
country_code
string

System field. The company country (ISO 3166-1 alpha-2 format).

​
is_test
boolean

System field:

  • true — a test account;
  • false — a production account.
​
has_active_admin
boolean

System field.

​
seller
integer | null

ID of the Seller.

​
resellers
integer

ID of the Reseller.

​
client_type
enum<string>

Client's type.

Available options:
common,
reseller,
sales
​
owner
number

Id of the user, who created client.