Developer
Telephone
United States
+1 (800) 815 - 9959
10:00 AM - 5:00 PM (EST/EDT)
Monday - Friday
Projects
Projects
Last updated: May 3, 2024
Last updated: May 3, 2024
List All Existing Projects
Historical price:
free
free
This request returns a list of all projects with their ID, project name, domain name, and tools activated for each project.
Request parameters
| Name | Value/Type | Description |
|---|---|---|
| key* | API_KEY | Identification key assigned to each user after subscribing to Semrush. You'll find it in Subscription info > API units. |
| filter |
One of: 'all', 'own' (default), 'share…
One of: 'all', 'own' (default), 'shared', 'corporate'.
|
Filter projects by user permissions. Use one of the possible values: |
* Fields marked by an asterisk (*) are required
Response parameters
| Name | Value/Type | Description |
|---|---|---|
| project_id | ID | Project ID. |
| project_name | Name | Project name. |
| url | domain.com | Project domain. |
| domain_unicode | domain.com | Project domain encoded in Unicode. |
| tools | List | List of project tools activated by the user. |
| owner_id | ID | Project owner ID. |
| permission | List | Project permissions of the user with the submitted ID key. Possible values: |
* Fields marked by an asterisk (*) are required
Endpoint (GET)
https://api.semrush.com/management/v1/projects
Request example
https://api.semrush.com/management/v1/projects?key=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"
]
}
]
Get Information About An Existing Project
This request returns information about a project, including its ID, project name, domain name, and activated tools.
Request parameters
| Name | Value/Type | Description |
|---|---|---|
| key* | API_KEY | Identification key assigned to each user after subscribing to Semrush. You'll find it in Subscription info > API units. |
| id* | ID | Project ID. Learn how to get your project ID › |
* Fields marked by an asterisk (*) are required
Response parameters
| Name | Value/Type | Description |
|---|---|---|
| project_id | ID | Project ID. |
| project_name | Name | Project name. |
| url | domain.com | Project domain. |
| domain_unicode | domain.com | Project domain encoded in Unicode. |
| tools | List | List of project tools activated by the user. |
| owner_id | ID | Project owner ID. |
| permission | List | Project permissions of the user with the submitted ID key. Possible values: |
* Fields marked by an asterisk (*) are required
Endpoint (GET)
https://api.semrush.com/management/v1/projects/
Request example
https://api.semrush.com/management/v1/projects/{id}?key=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"
]
}
Create A New Project
This request lets you create a new project, name it, and assign a domain.
Request parameters
| Name | Value/Type | Description |
|---|---|---|
| key* | API_KEY | Identification key assigned to each user after subscribing to Semrush. You'll find it in Subscription info > API units. |
| url* | domain.com | Project domain. |
| project_name | Name | Project name. You can't use any of the following symbols: |
* Fields marked by an asterisk (*) are required
Response parameters
| Name | Value/Type | Description |
|---|---|---|
| project_id | ID | Project ID. |
| project_name | Name | Project name. |
| url | domain.com | Project domain. |
| domain_unicode | domain.com | Project domain encoded in Unicode. |
| tools | List | List of project tools activated by the user. |
| owner_id | ID | Project owner ID. |
| permission | List | Project permissions of the user with the submitted ID key. Possible values: |
* Fields marked by an asterisk (*) are required
Endpoint (POST)
https://api.semrush.com/management/v1/projects?key=API_KEY
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"
]
}
Update An Existing Project
This request lets you rename a project.
Request parameters
| Name | Value/Type | Description |
|---|---|---|
| key* | API_KEY | Identification key assigned to each user after subscribing to Semrush. You'll find it in Subscription info > API units. |
| project_id* | ID | Project ID. Learn how to get your project ID › |
| project_name* | Name | New project name. |
* Fields marked by an asterisk (*) are required
Response parameters
| Name | Value/Type | Description |
|---|---|---|
| project_id | ID | Project ID. |
| project_name | Name | New project name. |
| url | domain.com | Project domain. |
| domain_unicode | domain.com | Project domain encoded in Unicode. |
| tools | List | List of project tools activated by the user. |
| owner_id | ID | Project owner ID. |
| permission | List | Project permissions of the user with the submitted ID key. Possible values: |
* Fields marked by an asterisk (*) are required
Endpoint (PUT)
https://api.semrush.com/management/v1/projects?key=API_KEY
Request example
{
"project_id": 643526670283248,
"project_name": "New project name"
}
Response example
{
"url": "mysite.com",
"domain_unicode": "mysite.com",
"tools": [
{
"tool": "tracking"
}
],
"project_id": 643526670283248,
"project_name": "New project name",
"owner_id": 123456780,
"permission": [
"OWNER"
]
}
Delete an existing project
This request lets you delete a project and all campaigns in the activated tools.
Request parameters
| Name | Value/Type | Description |
|---|---|---|
| key* | API_KEY | Identification key assigned to each user after subscribing to Semrush. You'll find it in Subscription info > API units. |
| id* | ID | Project ID. Learn how to get your project ID › |
* Fields marked by an asterisk (*) are required
Endpoint (DELETE)
https://api.semrush.com/management/v1/projects/{id}?key=API_KEY
Request example
https://api.semrush.com/management/v1/projects/{id}?key=API_KEY