> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api.labelstud.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.labelstud.io/_mcp/server.

# ✨ Move a saved interface to another workspace

POST http://localhost:8000/api/interfaces/{id}/move/
Content-Type: application/json

This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)

Move a saved interface to a workspace, your Personal Sandbox, or Shared (`workspace: null`). A workspace-scoped interface can only be used by projects in its workspace, so connected projects move with it when needed. Send `dry_run: true` first to get the move plan, then confirm with `dry_run: false` and the `expected_project_ids` from that plan. The response is the plan in every case; a blocked move or a changed plan returns 409 with the fresh plan.

Reference: https://api.labelstud.io/api-reference/api-reference/interfaces/move

## Authentication

- `Authorization` header (required) (prefixed with ` Token   `) — The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: curl [https://label-studio-host/api/projects](https://label-studio-host/api/projects) -H "Authorization: Token \[your-token]"

## Request

### Path parameters

- `id` (integer, required) — A unique integer value identifying this interface.

### Body (application/json)

This endpoint expects a LseInterfaceMoveRequestRequest.

- `workspace` (integer, required, nullable) — Target workspace ID, or null to make the interface Shared.
- `dry_run` (boolean, optional, default: false) — Return the move plan without changing anything.
- `expected_project_ids` (list of integer, optional) — Required when dry_run is false: IDs of the projects in workspace groups with outcome "move" from the dry run you confirmed. If the server computes a different set, it responds with 409 "interface_move_plan_changed" and the fresh plan.

## Response

### 200

- `allowed` (boolean, required)
- `blockers` (list of enum, required)
  - Allowed values: `published_projects`, `projects_cannot_move`, `inaccessible_projects`, `project_limit`
- `cannot_move_projects_count` (integer, required)
- `connected_projects_count` (integer, required) — All connected projects, inaccessible ones included.
- `inaccessible_projects_count` (integer, required)
- `moving_projects_count` (integer, required)
- `notices` (list of enum, required)
  - Allowed values: `target_shared`, `projects_stay_private`, `target_private`, `target_workspace_visible`, `restricted_to_target`
- `published_projects_count` (integer, required)
- `target` (LseInterfaceMoveWorkspace, required, nullable) — Target workspace, or null for Shared.
- `workspaces` (list of LseInterfaceMoveWorkspaceGroup, required) — Accessible connected projects grouped by workspace.
- `code` (enum, optional) — Present on 409 responses. * `interface_move_blocked` - Interface move blocked * `interface_move_plan_changed` - Interface move plan changed * `interface_move_requires_confirmation` - Interface move requires confirmation
  - Allowed values: `interface_move_blocked`, `interface_move_plan_changed`, `interface_move_requires_confirmation`
- `detail` (string, optional) — Present on 409 responses.

## Types

### LseInterfaceMoveWorkspace

- `color` (string, required, nullable)
- `id` (integer, required)
- `is_personal` (boolean, required)
- `title` (string, required)

### LseInterfaceMoveWorkspaceGroup

- `outcome` (enum, required) — * `move` - Move * `already_in_target` - Already in target * `stay` - Stay * `cannot_move` - Cannot move
  - Allowed values: `move`, `already_in_target`, `stay`, `cannot_move`
- `outside_interface_workspace` (boolean, required) — The projects sit in a different workspace from the interface's workspace.
- `projects` (list of LseInterfaceMoveProject, required)
- `published_projects_count` (integer, required) — Published projects in this workspace group that stop a move into a Personal Sandbox.
- `workspace` (LseInterfaceMoveWorkspace, required, nullable)

### LseInterfaceMoveProject

- `blocking_reasons` (list of enum, required) — Why this project stops the move. Empty when it does not.
  - Allowed values: `cannot_move`, `published`
- `id` (integer, required)
- `is_published` (boolean, required)
- `title` (string, required, nullable)

## Examples

**Request**

```json
{
  "workspace": 1
}
```

**Response**

```json
{
  "allowed": true,
  "blockers": [
    "published_projects"
  ],
  "cannot_move_projects_count": 1,
  "connected_projects_count": 1,
  "inaccessible_projects_count": 1,
  "moving_projects_count": 1,
  "notices": [
    "target_shared"
  ],
  "published_projects_count": 1,
  "target": {
    "color": "string",
    "id": 1,
    "is_personal": true,
    "title": "string"
  },
  "workspaces": [
    {
      "outcome": "move",
      "outside_interface_workspace": true,
      "projects": [
        {
          "blocking_reasons": [
            "cannot_move"
          ],
          "id": 1,
          "is_published": true,
          "title": "string"
        }
      ],
      "published_projects_count": 1,
      "workspace": {
        "color": "string",
        "id": 1,
        "is_personal": true,
        "title": "string"
      }
    }
  ],
  "code": "interface_move_blocked",
  "detail": "string"
}
```

**SDK Code**

```python
import requests

url = "http://localhost:8000/api/interfaces/1/move/"

payload = { "workspace": 1 }
headers = {
    "Authorization": "Token  <api_key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'http://localhost:8000/api/interfaces/1/move/';
const options = {
  method: 'POST',
  headers: {Authorization: 'Token  <api_key>', 'Content-Type': 'application/json'},
  body: '{"workspace":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8000/api/interfaces/1/move/"

	payload := strings.NewReader("{\n  \"workspace\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Token  <api_key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:8000/api/interfaces/1/move/")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Token  <api_key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspace\": 1\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("http://localhost:8000/api/interfaces/1/move/")
  .header("Authorization", "Token  <api_key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspace\": 1\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:8000/api/interfaces/1/move/', [
  'body' => '{
  "workspace": 1
}',
  'headers' => [
    'Authorization' => 'Token  <api_key>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:8000/api/interfaces/1/move/");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Token  <api_key>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"workspace\": 1\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Token  <api_key>",
  "Content-Type": "application/json"
]
let parameters = ["workspace": 1] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8000/api/interfaces/1/move/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```