Get access to 30+ marketing and SEO tools. analyze competitors, keywords, and backlinks for free..
Sign in Sign Up

We use cookies to make Serpstat better. By clicking "Accept cookies", you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. Learn more

Obtaining the list of projects and their status (RtApiProjectProcedure.getProjects)

The RtApiProjectProcedure.getProjects method returns the list of projects and their status. All not removed projects of the user making the request are returned.

Request parameters
Parameter
Value Description
id any number or string Request ID
method RtApiProjectProcedure.getProjects API method name
params {...} Array of parameters
page (required) 1
Page number. 1 by default
pageSize (optional) 100

Number of results per page. 100 by default

Response parameters
Parameter Description
id Request ID
result Contains the answer
data Units array
projectId

Project ID

projectName
Project name
domain Domain for which the project created
createdAt

Project's creation date

group An array of groups connected with the project
type

Connection type between owner and project (owner — owner of a project, read — read only, edit — edit access)

status Project status (8 — the project is not configured, 9 — the project is configured)
enableTracking

The parameter indicates whether automatic position removal is enabled in the project (true — turned on, false — turned off)

currentPage Number of response results pages
pageSize

Results per response page

total Total number of results

Example
Request data:
{
    "id": 1,
    "method": "RtApiProjectProcedure.getProjects",
    "params": {
        "page": 1
        "pageSize": 100
    }
}
Response data:
{
    "id": "1",
    "result": {
        "data": [
            {
                "projectId" : 3456457,
                "projectName": "shopify.com",
                "domain": "shopify.com",
                "createdAt": "2020-02-10 10:09:25",
                "group": "Default group",
                "type": "owner",
                "status": 9,
                "enableTracking": false
            },
            {
                "projectId" : 3456457,
                "projectName": "ukr.net",
                "domain": "ukr.net",
                "createdAt": "2019-12-19 16:11:07",
                "group": "Default group",
                "type": "owner",
                "status": 9,
                "enableTracking": true
            }
        ],
        "currentPage": 2,
        "pageSize": 3,
        "total": 2
    }
}

Share this article with your friends

Sign In Free Sign Up

You’ve reached your query limit.

Or email
Forgot password?
Or email
Optional
Back To Login

Don’t worry! Just fill in your email and we’ll send over your password.

Are you sure?

Awesome!

To complete your registration you need to enter your phone number

Back

We sent confirmation code to your phone number

Your phone Resend code Queries left

Something went wrong.

Contact our support team
Or confirm the registration using the Telegram bot Follow this link
Please pick the project to work on

Introducing Serpstat

Find out about the main features of the service in a convenient way for you!

Please send a request, and our specialist will offer you education options: a personal demonstration, a trial period, or materials for self-study and increasing expertise — everything for a comfortable start to work with Serpstat.

Name

Email

Phone

We are glad of your comment
Upgrade your plan

Upgrade your plan

Export is not available for your account. Please upgrade to Lite or higher to get access to the tool. Learn more

Sign Up Free

Thank you, we have saved your new mailing settings.

Invite
View Editing

E-mail
Message
Optional
E-mail
Message
Optional

You have run out of limits

You have reached the limit for the number of created projects. You cannot create new projects unless you increase the limits or delete existing projects.

I want more limits
Open support chat