How You Can Help Ukrainians Today (SE Ranking Team Included)Learn here

User seats (sub-accounts)

View of a user sub-accounts

Description

The method allows you to get a list of all sub-accounts of a user.

Request format

GET /users

Parameters:

NameDescription
limitDisplay limit per page, default 100
offsetSelection 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.

NameDescription
account_idUnique account ID
account_emailEmail sub-account
account_first_nameName
account_last_nameLast name
account_ typeAccount type (user, client)
account_ langAccount language
account_ sites_countNumber of available websites per account
is_blocked_by_limitsbool 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”
}

Getting extended information about a sub-account

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:

NameDescription
settingssub-account information
accesssub-account access
limitsub-account limits

The access element consists of the following fields:

NameDescription
audit_websiteWebsite audit
competitors_visibility_rankingVisibility ranking
audit_settingsAudit settings
backlink_monitorBacklink monitor
analytics_conversionsAnalytics: conversions
analytics_google_search_consoleGoogle search console
competitors_addedMain competitors
analytics_overviewAnalytics: overview
analytics_pagesAnalytics: pages
marketing_planMarketing plan
seo_potentialSEO potential
analytics_snippetsAnalytics: snippet
social_mediaSocial media
tools_backlinks_checkerTools: backlinks checker
tools_index_status_checkerTools: index status checker
tools_parameter_checkerTools: parameter checker
tools_keyword_grouperTools: keyword grouped
tools_engine_autocompleteTools: engine autocomplete
tools_search_volume_checkerTools: search volume checker
tools_competitive_researchTools: competitive research
tools_keyword_researchTools: keyword research
tools_one_page_seo_checkerTools: one-page seo checker
competitors_serpCompetitors serp
analytics_traffic_sourcesAnalytics: traffic sources
analytics_audienceAnalytics: audience
audit_page_changes_monitorAudit: page changes monitor
hide_search_volumeIs hide search volume for client account type
show_groupsShow groups
report_manualReport manual
report_scheduledReport scheduled
report_templateReport template

The limit element consists of the following fields:

NameDescription
siteint, limits on adding websites
keywordint, limits on adding keywords
backlinkint, limits on adding backlink checks
audit_accountint, website verification limit (per account)
audit_siteint, website check limit (per site per month)
balance.pamountint, payment limits
balance.periodstring, 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”
}
}
}

Sub-account creation

Description

The method allows you to create a sub-account and send a notification letter to the email of the created sub-account.

NameRequiredDescription
keyYesRequired value “data”
valueYesCreated account settings
setting.account_emailYesEmail of the future sub-account
setting.account_first_nameYesSub-account name
setting.account_last_nameNo Sub-account last name
setting.account_passwordYesSub-account password
setting.account_langNoAccount language. Two-letter code
setting.account_typeNoAccount type: client, user
limit.balance.periodNoValidity period for limits day,week,month
limit.balance.amountNoLimit value in money, int
accessNoAccess 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
}
NameDescription
idUnique account identifier

Deleting a 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

[]

Sub-account editing

Description

The method allows you to edit an existing sub-account.

NameRequiredDescription
keyYesRequired value “data”
valueYesSettings of the created account
setting.account_emailNoEmail of the future sub-account
setting.account_first_nameNoSub-account name
setting.account_last_nameNoSub-account last name
setting.account_passwordNoSub-account password
setting.account_langNoAccount language. Two-letter code
setting.account_typeNoAccount type: client, user
limit.balance.periodNoValidity period for limits day,week,month
limit.balance.amountNoLimit value in money, int
accessNoSection with new sub-account permissions

Request format

PATCH /users/{id}
[
{
“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”
]
}
]
}
]

Result

If successful, the server returns an empty array.

Response example:

{
[]
}

Getting a list of websites shared to a sub-account by a parent account

Description

The method allows you to get a list of websites available for a sub-account.

Request format

GET /users/{id}/shared-sites
NameDescription
idUnique account identifier

Result

If successful, the server returns an array of unique IDs of shared websites for a sub-account.

Response example:

[
39,
44
]

Getting a list of websites belonging to a sub-account

Description

The method allows you to get a list of websites belonging to a sub-account.

Request format

GET /users/{id}/own-sites
NameDescription
idUnique account identifier

Result

If successful, the server returns an array of unique website IDs belonging to the sub-account.

Response example:

[
39,
44
]

Granting a sub-account access to websites

Description

The method allows you to share a website with a sub-account.

Request format

POST /users/{id}/shared-sites
[39,42]
NameDescription
idUnique sub-account identifier
39, 42Unique website identifiers

Result

If successful, the server returns an empty array.

Response example

{
[]
}