Endpointget /v3/workspaces
Query Parameters
folder_id int |
The ID of the folder for which you want to list all workspaces. |
Response200 400 401 429
workspace_id int |
A unique workspace ID.
|
name string |
The name of the workspace.
|
folder_id int |
The ID of the folder to which this workspace was added.
|
share_link string |
The URL to share the workspace with 3rd parties. No login required.
|
|
cURL
curl "https://{your_name}.api.advalify.io/v3/workspaces"
-H "X-ApiKey: TCm2Hd_rT4pRNvSZ2cGYCJ6... (example)"
-X GET
Example Response
[{ "workspace_id": 892872389, "name": "My workspace", "folder_id": 728838992, "share_link": "https://share.advalify.io/ca/30d9k-682120816-cb47b148" }, { "workspace_id": 548937770, "name": "Another workspace", "folder_id": 132992888, "share_link": "https://share.advalify.io/ca/30d9k-821620816-7b148cb4" }]
|
Endpointpost /v3/workspaces
Parameters
folder_id int, required |
The ID of the folder to which you want add the workspace. |
name string, required |
The name of the workspace. |
Response200 400 401 429
workspace_id int |
The unique workspace ID.
|
|
cURL
curl "https://{your_name}.api.advalify.io/v3/workspaces"
-H "X-ApiKey: TCm2Hd_rT4pRNvSZ2cGYCJ6... (example)"
-X POST
-d '{ "folder_id": 837193849, "name": "New workspace name" }'
Example Response
{ "workspace_id": 328083047 }
|
Endpointget /v3/workspaces/{workspace_id}
Response200 400 401 429
workspace_id int |
A unique workspace ID.
|
name string |
The name of the workspace.
|
folder_id int |
The ID of the folder to which this workspace was added.
|
share_link string |
The URL to share the workspace with 3rd parties. No login required.
|
|
cURL
curl "https://{your_name}.api.advalify.io/v3/workspaces/{workspace_id}"
-H "X-ApiKey: TCm2Hd_rT4pRNvSZ2cGYCJ6... (example)"
-X GET
Example Response
{ "workspace_id": 892872389, "name": "My workspace", "folder_id": 728838992, "share_link": "https://share.advalify.io/ca/30d9k-821620816-7b148cb4" }
|
Endpointput /v3/workspaces/{workspace_id}
Parameters
name string, required |
The name of the workspace. |
|
cURL
curl "https://{your_name}.api.advalify.io/v3/workspaces/{workspace_id}"
-H "X-ApiKey: TCm2Hd_rT4pRNvSZ2cGYCJ6... (example)"
-X PUT
-d '{ "name": "New workspace name" }'
|
Endpointdelete /v3/workspaces/{workspace_id}
|
cURL
curl "https://{your_name}.api.advalify.io/v3/workspaces/{workspace_id}"
-H "X-ApiKey: TCm2Hd_rT4pRNvSZ2cGYCJ6... (example)"
-X DELETE
|