Telephone
United States
+1 (800) 815 - 9959
10:00 AM - 6:00 PM (EST/EDT)
Monday - Friday
Need help?
Telephone
United States
United States
Canada
United Kingdom
Spain
France
Italy
Germany
Australia
+1 (800) 815 - 9959
10:00 AM - 6:00 PM (EST/EDT)
Monday - Friday
This request allows you to get a list of all projects, including their ID, project name and domain name, as well as tools that have been activated for each project.
Name | Value/Type | Description |
---|---|---|
key* | API_KEY | An identification key assigned to a user after subscribing to SEMrush that is available via Profile page |
filter |
One of: 'all', 'own' (default), 'share…
One of: 'all', 'own' (default), 'shared', 'corporate'.
|
Filter projects by user permission. Could be one of: |
* Fields marked by an asterisk (*) are required
Name | Value/Type | Description |
---|---|---|
project_id | ID | Project ID |
project_name | Name | The name of a project |
url | domain.com | The domain of a project |
domain_unicode | domain.com | The domain of a project in unicode |
tools | List | List of project tools activated by a user |
owner_id | ID | The owner ID of a project |
permission | List | Project permissions for api key user. Could be: "OWNER", "READ", "WRITE", "CORP_ADMIN_READ", "CORP_ADMIN_WRITE". |
* Fields marked by an asterisk (*) are required
Endpoint
Request example
https://api.semrush.com/management/v1/projects?key=YOUR_API_KEY
Response example
[ { "url": "mysite.com", "domain_unicode": "mysite.com", "tools": [ { "tool": "tracking" } ], "project_id": 643526670283248, "project_name": "myproject", "owner_id": 123456780, "permission": [ "OWNER" ] } ]
This request allows you to get information regarding a project, including its ID, project name and domain name, as well as tools that have been activated for this project.
Name | Value/Type | Description |
---|---|---|
key* | API_KEY | An identification key assigned to a user after subscribing to SEMrush that is available via Profile page |
id* | ID | Project ID |
* Fields marked by an asterisk (*) are required
Name | Value/Type | Description |
---|---|---|
project_id | ID | Project ID |
project_name | Name | The name of a project |
url | domain.com | The domain of a project |
domain_unicode | domain.com | The domain of a project in unicode |
tools | List | List of project tools activated by a user |
owner_id | ID | The owner ID of a project |
permission | List | Project permissions for api key user. Could be: "OWNER", "READ", "WRITE", "CORP_ADMIN_READ", "CORP_ADMIN_WRITE". |
* Fields marked by an asterisk (*) are required
Endpoint (GET)
Request example
https://api.semrush.com/management/v1/projects/{id}?key=YOUR_API_KEY
Response example
{ "url": "mysite.com", "domain_unicode": "mysite.com", "tools": [ { "tool": "tracking" } ], "project_id": 643526670283248, "project_name": "myproject", "owner_id": 123456780, "permission": [ "OWNER" ] }
This request allows you to create a new project, which includes naming the project and choosing a domain.
Name | Value/Type | Description |
---|---|---|
key* | API_KEY | An identification key assigned to a user after subscribing to SEMrush that is available via Profile page |
url* | domain.com | The domain of a project |
project_name | Name | The name of a user's project. Forbidden characters are ~`!#%'^&*=[]\/{}|":<>? |
* Fields marked by an asterisk (*) are required
Name | Value/Type | Description |
---|---|---|
project_id | ID | Project ID |
project_name | Name | The name of a project |
url | domain.com | The domain of a project |
domain_unicode | domain.com | The domain of a project in unicode |
tools | List | List of project tools activated by a user |
owner_id | ID | The owner ID of a project |
permission | List | Project permissions for api key user. Could be: "OWNER", "READ", "WRITE", "CORP_ADMIN_READ", "CORP_ADMIN_WRITE". |
* Fields marked by an asterisk (*) are required
Endpoint (POST)
Request example
{ "project_name": "myproject", "url": "mysite.com" }
Response example
{ "url": "mysite.com", "domain_unicode": "mysite.com", "tools": [ { "tool": "tracking" } ], "project_id": 643526670283248, "project_name": "myproject", "owner_id": 123456780, "permission": [ "OWNER" ] }
This request allows you to update or change a project’s name.
Endpoint (PUT)
Request example
{ "project_id": 643526670283248, "project_name": "my old project" }
Response example
{ "url": "mysite.com", "domain_unicode": "mysite.com", "tools": [ { "tool": "tracking" } ], "project_id": 643526670283248, "project_name": "myproject", "owner_id": 123456780, "permission": [ "OWNER" ] }
This request allows you to delete a project, including its all of tool campaigns.
Name | Value/Type | Description |
---|---|---|
key* | API_KEY | An identification key assigned to a user after subscribing to SEMrush that is available via Profile page |
id* | ID | Project ID |
* Fields marked by an asterisk (*) are required
Endpoint (DELETE)
Request example
https://api.semrush.com/management/v1/projects/{id}?key=YOUR_API_KEY