Documentation / Team / Endpoint
GET

/api/v1/team/profiles/{id}/transfer-preview

Check data scope and versions before transferring a profile

Request#

POSIX shell · curl
curl --fail-with-body --request GET \
  "$ADBR_API_URL/api/v1/team/profiles/{id}/transfer-preview" \
  -H "Authorization: Bearer $ADBR_API_TOKEN"

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs.

Authentication and permissions#

Authentication: Bearer token

Scopes: admin

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

ParameterLocationRequiredDescription
directionqueryYes
scopequeryNo
idpathYes
Complete parameter schemas
OpenAPI JSON
[
  {
    "schema": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "publish"
          ]
        },
        {
          "type": "string",
          "enum": [
            "download"
          ]
        },
        {
          "type": "string",
          "enum": [
            "apply"
          ]
        }
      ]
    },
    "in": "query",
    "name": "direction",
    "required": true
  },
  {
    "schema": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "profile"
          ]
        },
        {
          "type": "string",
          "enum": [
            "cookies"
          ]
        },
        {
          "type": "string",
          "enum": [
            "browser"
          ]
        }
      ]
    },
    "in": "query",
    "name": "scope",
    "required": false
  },
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Request body#

No request body declared.

Responses#

200 · Default response
OpenAPI JSON
{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "direction",
          "scope",
          "name",
          "token",
          "local_version",
          "remote_version",
          "remote_hash",
          "local_state",
          "local_changed",
          "effect",
          "blocked",
          "reason",
          "fields"
        ],
        "properties": {
          "direction": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "publish"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "download"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "apply"
                ]
              }
            ]
          },
          "scope": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "profile"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "cookies"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "browser"
                ]
              }
            ]
          },
          "name": {
            "type": "string"
          },
          "token": {
            "type": "string"
          },
          "local_version": {
            "type": "integer"
          },
          "remote_version": {
            "type": "integer"
          },
          "remote_hash": {
            "type": [
              "string",
              "null"
            ]
          },
          "local_state": {
            "type": "string"
          },
          "local_changed": {
            "type": "boolean"
          },
          "effect": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "new_local"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "new_version"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "new_share"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "selected_local"
                ]
              }
            ]
          },
          "blocked": {
            "type": "boolean"
          },
          "reason": {
            "type": [
              "string",
              "null"
            ]
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
default · HTTP error envelope. The status and error.code identify the failure.
OpenAPI JSON
{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition
OpenAPI JSON
{
  "summary": "Datenumfang und Versionen vor einer Profilübertragung prüfen",
  "tags": [
    "Team"
  ],
  "parameters": [
    {
      "schema": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "publish"
            ]
          },
          {
            "type": "string",
            "enum": [
              "download"
            ]
          },
          {
            "type": "string",
            "enum": [
              "apply"
            ]
          }
        ]
      },
      "in": "query",
      "name": "direction",
      "required": true
    },
    {
      "schema": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "profile"
            ]
          },
          {
            "type": "string",
            "enum": [
              "cookies"
            ]
          },
          {
            "type": "string",
            "enum": [
              "browser"
            ]
          }
        ]
      },
      "in": "query",
      "name": "scope",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "direction",
              "scope",
              "name",
              "token",
              "local_version",
              "remote_version",
              "remote_hash",
              "local_state",
              "local_changed",
              "effect",
              "blocked",
              "reason",
              "fields"
            ],
            "properties": {
              "direction": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "publish"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "download"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "apply"
                    ]
                  }
                ]
              },
              "scope": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "profile"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "cookies"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "browser"
                    ]
                  }
                ]
              },
              "name": {
                "type": "string"
              },
              "token": {
                "type": "string"
              },
              "local_version": {
                "type": "integer"
              },
              "remote_version": {
                "type": "integer"
              },
              "remote_hash": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "local_state": {
                "type": "string"
              },
              "local_changed": {
                "type": "boolean"
              },
              "effect": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "new_local"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "new_version"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "new_share"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "selected_local"
                    ]
                  }
                ]
              },
              "blocked": {
                "type": "boolean"
              },
              "reason": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "fields": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

Search for headless, MCP, cookies or an API endpoint.

↑ ↓ NavigateEnter OpenEsc Close