Sub-Account Management
List sub-accounts
Description
The method allows you to get a list of all sub-accounts of a user.
Request format
| GET /users |
Parameters:
| Name | Description |
| limit | Display limit per page, default 100 |
| offset | Selection bias |
Result
If successful, the server returns an object with a list of sub-accounts (list) and their total number as a separate entry (all_count).
Each element of the list array represents information about the sub-account.
| Name | Description |
| account_id | Unique account ID |
| account_email | Email sub-account |
| account_first_name | Name |
| account_last_name | Last name |
| account_type | Account type (user, client) |
| account_lang | Account language |
| account_sites_count | Number of available websites per account |
| is_blocked_by_limits | bool value. Are the limits expired? |
Response example
| { “list”: [ { “account_id”: 36865, “account_email”: “[email protected]”, “account_first_name”: “John”, “account_last_name”: “Doe”, “account_type”: “user”, “account_lang”: “ru”, “account_sites_count”: 2, “is_blocked_by_limits”: false }, { “account_id”: 36828, “account_email”: “[email protected]”, “account_first_name”: “Jane”, “account_last_name”: “Doe”, “account_type”: “client”, “account_lang”: “ru”, “account_sites_count”: 1, “is_blocked_by_limits”: false } ], “all_count”: “2”} |
Get Sub-Account Details
Description
The method allows you to get extended information about the sub-account, including limits and permissions.
Request format
| GET /users/{id} |
Result
If successful, the server returns an object consisting of the three elements:
| Name | Description |
| settings | sub-account information |
| access | sub-account access |
| limit | sub-account limits |
The access element consists of the following fields:
| Name | Description |
| audit_website | Website audit |
| competitors_visibility_ranking | Visibility ranking |
| audit_settings | Audit settings |
| backlink_monitor | Backlink monitor |
| analytics_conversions | Analytics: conversions |
| analytics_google_search_console | Google search console |
| competitors_added | Main competitors |
| analytics_overview | Analytics: overview |
| analytics_pages | Analytics: pages |
| marketing_plan | Marketing plan |
| seo_potential | SEO potential |
| analytics_snippets | Analytics: snippet |
| social_media | Social media |
| tools_backlinks_checker | Tools: backlinks checker |
| tools_index_status_checker | Tools: index status checker |
| tools_parameter_checker | Tools: parameter checker |
| tools_keyword_grouper | Tools: keyword grouped |
| tools_engine_autocomplete | Tools: engine autocomplete |
| tools_search_volume_checker | Tools: search volume checker |
| tools_competitive_research | Tools: competitive research |
| tools_keyword_research | Tools: keyword research |
| tools_one_page_seo_checker | Tools: one-page seo checker |
| competitors_serp | Competitors serp |
| analytics_traffic_sources | Analytics: traffic sources |
| analytics_audience | Analytics: audience |
| audit_page_changes_monitor | Audit: page changes monitor |
| hide_search_volume | Is hide search volume for client account type |
| show_groups | Show groups |
| report_manual | Report manual |
| report_sheduled | Report scheduled |
| report_template | Report template |
The limit element consists of the following fields:
| Name | Description |
| site | int, limits on adding websites |
| keyword | int, limits on adding keywords |
| backlink | int, limits on adding backlink checks |
| audit_account | int, website verification limit (per account) |
| audit_site | int, website check limit (per site per month) |
| balance.amount | int, payment limits |
| balance.period | string, payment limit (day, week, month) |
Response example:
| { “setting”: { “account_id”: 36828, “account_email”: “[email protected]”, “account_first_name”: “Test”, “account_last_name”: “Test”, “account_type”: “user”, “account_lang”: “ru” }, “access”: [ “add_website”, “audit_settings”, “report_manual”, “report_sheduled”, “report_template” ], “limit”: { “site”: 10, “keyword”: 5, “backlink”: 10, “audit_account”: 4, “audit_site”: 3, “balance”: { “amount”: 5, “period”: “day” } }} |
Create Sub-Account
Description
The method allows you to create a sub-account and send a notification letter to the email of the created sub-account.
| Name | Required | Description |
| key | Yes | Required value “data” |
| value | Yes | Created account settings |
| setting.account_email | Yes | Email of the future sub-account |
| setting.account_first_name | Yes | Sub-account name |
| setting.account_last_name | No | Sub-account last name |
| setting.account_password | Yes | Sub-account password |
| setting.account_lang | No | Account language. Two-letter code |
| setting.account_type | No | Account type: client, user |
| limit.balance.period | No | Validity period for limits day,week,month |
| limit.balance.amount | No | Limit value in money, int |
| access | No | Access of the created sub-account to your personal account. |
Request format
| POST /users[ { “key”:”data”, “value”: [ {“setting.account_email”:”[email protected]”}, {“setting.account_first_name”:”Test”}, {“setting.account_last_name”:”Test”}, {“setting.account_password”:”TestPassword”}, {“setting.account_type”:”user”}, {“limit.balance.period”:”day”}, {“limit.balance.amount”:10}, “access”: [ “add_website”, “audit_settings”, “report_manual”, “report_sheduled”, “report_template” ] } ] }] |
Result
If successful, the server returns a unique identifier for the added sub-account.
Response example:
| { “id”: 36872} |
| Name | Description |
| id | Unique account identifier |
Delete Sub-Account
Description
The method allows you to delete a user’s sub-account.
Request format
| DELETE /users/{id} |
Result
If successful, the server returns an empty array
Response example
| [] |
Update Sub-Account
Description
The method allows you to edit an existing sub-account.
| Name | Required | Description |
| key | Yes | Required value “data” |
| value | Yes | Settings of the created account |
| setting.account_email | No | Email of the future sub-account |
| setting.account_first_name | No | Sub-account name |
| setting.account_last_name | No | Sub-account last name |
| setting.account_password | No | Sub-account password |
| setting.account_lang | No | Account language. Two-letter code |
| setting.account_type | No | Account type: client, user |
| limit.balance.period | No | Validity period for limits day,week,month |
| limit.balance.amount | No | Limit value in money, int |
| access | No | Section with new sub-account permissions |
Request format
| PATCH /users/{id}[ { “key”:”data”, “value”: [ {“setting.account_email”:”test@gmail.com“}, {“setting.account_first_name”:”Test”}, {“setting.account_last_name”:”Test”}, {“setting.account_password”:”TestPassword”}, {“setting.account_type”:”user”}, {“limit.balance.period”:”day”}, {“limit.balance.amount”:10}, {“access”: [ “add_website” ] } ] }] |
Result
If successful, the server returns an empty array.
Response example:
| { []} |
List Shared Projects
Description
The method allows you to get a list of websites available for a sub-account.
Request format
| GET /users/{id}/shared-sites |
| Name | Description |
| id | Unique account identifier |
Result
If successful, the server returns an array of unique IDs of shared websites for a sub-account.
Response example:
| [ 39, 44] |
List Owned Projects
Description
The method allows you to get a list of websites belonging to a sub-account.
Request format
| GET /users/{id}/own-sites |
| Name | Description |
| id | Unique account identifier |
Result
If successful, the server returns an array of unique website IDs belonging to the sub-account.
Response example:
| [ 39, 44] |
Share Project with Sub-Account
Description
The method allows you to share a website with a sub-account.
Request format
| POST /users/{id}/shared-sites[39,42] |
| Name | Description |
| id | Unique sub-account identifier |
| 39,42 | Unique website identifiers |
Result
If successful, the server returns an empty array.
Response example
| { []} |