Get list of projects
Use the ProjectProcedure.getProjects method to get a list of your projects.
The method will save you time on getting information on your project ID, name, date of creation without the need of entering the platform.
| Request parameters | |||||
| Parameter | Description | Type | Optional | Default value | Value options |
| id | A request id: the response contains the same id. | int / string | no | Any text or number value, for example: 1, test | |
| method | API method name | string | no | ProjectProcedure.getProjects | |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | yes | |||
| page | Page number in the projects list | int | yes | 1 | Number value, for example: 1, 5 |
| size | Number of results per page in the project list | int | yes | 100 | Choose any number from the following: 20, 50, 100, 200, 500 |
| Response parameters | |
| Parameters | Description |
| id | Request id |
| data | Array with data |
| result | Contains the answer. |
| project_id | Your project's ID |
| project_name | Your project's name |
| domain | Project's domain name |
| created_at | Date and time when the project was created |
| group | Project's group |
| type | Project's type ("owner" — you are the owner of this project, "reader" — the project's owner is a member of your team. In case you use Team management.) |
| summary_info | Object with general data |
| page | Page number |
| page_total | Number of pages per request |
| count | Number of responses per request |
| total | Total amount of projects |
Credits for this method are not deducted.
Request data:
{
"id": 1,
"method": "ProjectProcedure.getProjects",
"params": {
"page": 1,
"size": 20
}
}Response data:
{
"id": "1",
"result": {
"data": [
{
"project_id": "1075717",
"project_name": "premierleague.com",
"domain": "premierleague.com",
"created_at": "2022-10-06T15:14:04",
"group": "Default group",
"type": "owner"
},
{
"project_id": "1068077",
"project_name": "manutd.com",
"domain": "manutd.com",
"created_at": "2022-09-13T09:38:26",
"group": "Default group",
"type": "reader"
},
{
"project_id": "1020237",
"project_name": "serpstat.com",
"domain": "serpstat.com",
"created_at": "2022-04-05T13:29:48",
"group": "Default group",
"type": "owner"
},
{
"project_id": "1011814",
"project_name": "savelife.in.ua",
"domain": "savelife.in.ua",
"created_at": "2022-03-02T07:28:36",
"group": "Default group",
"type": "owner"
},
{
"project_id": "984810",
"project_name": "stuff-shop.com",
"domain": "stuff-shop.com",
"created_at": "2021-12-28T07:39:09",
"group": "Default group",
"type": "owner"
},
{
"project_id": "977224",
"project_name": "louisianebrewhouse.com.vn",
"domain": "louisianebrewhouse.com.vn",
"created_at": "2021-12-10T07:36:24",
"group": "Default group",
"type": "owner"
},
{
"project_id": "968290",
"project_name": "webttx.com",
"domain": "webttx.com",
"created_at": "2021-11-26T11:40:39",
"group": "Default group",
"type": "owner"
},
{
"project_id": "944598",
"project_name": "Teepublic",
"domain": "teepublic.com",
"created_at": "2021-10-05T12:13:35",
"group": "Default group",
"type": "owner"
}
],
"summary_info": {
"page": 1,
"page_total": 1,
"count": 20,
"total": 8
}
}
}