Parameters for Account Search
This section describes parameters that you can use when you search for accounts.
Parameter | Description |
---|---|
type |
The type of an account:
For example:
|
firstname |
The account’s first name or its part. For example: |
lastname |
The account’s last name or its part. For example: |
company |
The account’s company name or its part. For example: |
email |
The account’s full email. For example: |
phone |
The account’s full phone number. For example: |
reseller |
The reseller account assigned to an account (customer or operator’s). This can be a reseller to which a customer or operator is directly or indirectly subordinate. This means that the reseller is any level higher in the account hierarchy. You can specify a reseller account by its ID or its name. Examples:
This query finds accounts that are one or more hierarchical levels lower than accounts that have the word “truehost” in their names. In other words, it finds their direct and indirect subordinate accounts.
This query finds accounts that do not have a reseller with ID=1234567 at any level higher in the account hierarchy. |
parent |
The parent account assigned to an account. Parent accounts are only one hierarchical level higher. You can specify a parent account by its ID or its name. Examples:
This query finds all accounts that are directly subordinate to the accounts with the word “plesk” in their names. In other words, it finds direct, or immediate, subordinate accounts.
This query finds accounts whose parent account has an ID other than 1234567. |
apilogin |
The Partner API login assigned to a user account. This parameter supports “:” and “:=” operators. Use the “parameter:=value” notation if you need exact value matching. If matching by a part of a value suits you, use the “parameter:value” notation. For example:
|
geo |
The region of the country of an account. Use an empty string to find accounts for which no region is specified. The following regions are supported:
|
country |
The ISO code of the account’s country of residence. For example:
|
majorcustomer |
The name or a part of the name of a major customer associated with an account. Use an empty string (“”) to find accounts for which no major customer is specified. Example:
|
salesperson |
The name or the ID of a salesperson. If you specify a number, the search is performed against account IDs. If no ID was found, the search is performed against sales person names. Use an empty string (“”) to find accounts for which no sales person is specified. Examples:
|
creation |
The date of a user account creation. Examples:
|
lastlogin |
The date when a user last logged in. Use an empty string (“”) to find accounts for which no date of the last login exists. Examples:
|
id |
The ID of an account. Examples:
|
login |
The Partner Central login used by an account. Partner Central logins are in fact user emails. Use an empty string (“”) to find accounts for which no Partner Central login is specified. Examples:
|
alias |
The alias of an account, also known as the legacy Key Administrator login. Examples:
|
access |
The system to which the account has access (Key Administrator or Partner Central). Use an empty string (“”) to find accounts for which no product access is specified. Examples:
|
totalkeys |
The total number of license keys assigned to the account and to all its subordinate accounts. Supported operators: “:”, “>”, “>=”, “<”, “<=”. Example:
|
activekeys |
The total number of active license keys assigned to the account and to all its subordinate accounts. Supported operators: “:”, “>”, “>=”, “<”, “<=”. Example:
|
expiringkeys |
The total number of nearly expired license keys assigned to the account and to all its subordinate accounts. These are licenses with an expiration date within 10 days from the current date. Supported operators: “:”, “>”, “>=”, “<”, “<=”. Example:
|
expiredkeys |
The total number of expired license keys assigned to the account and to all its subordinate accounts. Supported operators: “:”, “>”, “>=”, “<”, “<=”. Example:
|
suspendedkeys |
The total number of suspended license keys assigned to the account and to all its subordinate accounts. Supported operators: “:”, “>”, “>=”, “<”, “<=”. Example:
|
terminatedkeys |
The total number of terminated license keys assigned to the account and to all its subordinate accounts. Supported operators: “:”, “>”, “>=”, “<”, “<=”. Example:
|