Sub-Account Management

Sub-Account Management API provides endpoints to manage user sub-accounts, including creation, modification, deletion, access configuration, limits management, and project sharing.

List sub-accounts

GET https://api4.seranking.com/users

Returns a list of all sub-accounts associated with the authenticated user.

Request parameters

Request example

GET https://api4.seranking.com/users?limit=100&offset=0

Response parameters

If successful, the server returns the 200 HTTP status code and a list of sub-accounts.

Each object in the list array has the following structure:

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

GET https://api4.seranking.com/users/{id}

Returns extended information about the specified sub-account, including settings, access permissions, and limits.

Request parameters

Request example

GET https://api4.seranking.com/users/36828

Response parameters

If successful, the server returns the 200 HTTP status code and sub-account details. Returns HTTP 404 if the sub-account is not found (for more information, see Error handling).

The settings object has the following structure:

The access array can list the following permissions:

The limit object has the following structure:

The balance object has the following structure:

Response example

{

  "settings": {    

    "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_scheduled",    

    "report_template"

  ],

  "limit": {   

    "site": 10,   

    "keyword": 5,   

    "backlink": 10,   

    "audit_account": 4,   

    "audit_site": 3,    

    "balance": {      

      "amount": 5,      

      "period": "day"  

    }

  }

}

Create sub-account

POST https://api4.seranking.com/users

Creates a new sub-account and sends a notification email to the specified sub-account address.

Request parameters

The request body must contain a data object with sub-account configuration.

Request example

POST https://api4.seranking.com/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_scheduled",

        "report_template"

      ]}

    ]

  }

]

Response parameters

If successful, the server returns the 201 HTTP status code and the created sub-account identifier.

Response example

{ "id": 36872}

Delete sub-account

DELETE https://api4.seranking.com/users/{id}

Deletes a sub-account.

Request parameters

Request example

DELETE https://api4.seranking.com/users/123

Response parameters

If successful, the server returns an empty array. Returns HTTP 404 if the sub-account is not found (for more information, see Error handling).

Response example

[]

Update sub-account

PATCH https://api4.seranking.com/users/{id}

Updates an existing sub-account.

Request parameters

The request body must contain a data object with sub-account configuration.

Request example

PATCH https://api4.seranking.com/users/36828

[

  {

    "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"]}

    ]

  }

]

Response parameters

If successful, the server returns an empty array. Returns HTTP 404 if the sub-account is not found (for more information, see Error handling).

Response example

[]

List shared projects

GET https://api4.seranking.com/users/{id}/shared-sites

Returns website IDs shared with the sub-account.

Request parameters

Request example

GET https://api4.seranking.com/users/123/shared-sites

Response parameters

If successful, the server returns the 200 HTTP status code and an array of website IDs.

Response example

[ 39, 44]

List owned projects

GET https://api4.seranking.com/users/{id}/own-sites

Returns a list of website IDs owned by the specified sub-account.

Request parameters

Request example

GET https://api4.seranking.com/users/123/own-sites

Response parameters

If successful, the server returns an array of unique website IDs.

Response example

[ 39, 40]

Share project with sub-account

POST https://api4.seranking.com/users/{id}/shared-sites

Shares websites with a sub-account.

Request parameters

Request example

POST https://api4.seranking.com/users/36828/shared-sites

[39, 42]

Response parameters

If successful, the server returns an empty array.

Response example

[]