Documentation / Team / Endpoint
GET

/api/v1/team/profiles/{id}/lease

Current usage of a team share on other devices

Request#

POSIX shell · curl
curl --fail-with-body --request GET \
  "$ADBR_API_URL/api/v1/team/profiles/{id}/lease" \
  -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
idpathYes
Complete parameter schemas
OpenAPI JSON
[
  {
    "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": [
          "profile_id",
          "lease"
        ],
        "properties": {
          "profile_id": {
            "type": "string"
          },
          "lease": {
            "anyOf": [
              {
                "type": "object",
                "required": [
                  "member_id",
                  "member_name",
                  "email",
                  "device_id",
                  "device_name",
                  "purpose",
                  "acquired_at",
                  "renewed_at",
                  "expires_at"
                ],
                "properties": {
                  "member_id": {
                    "type": "string"
                  },
                  "member_name": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "email": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "device_id": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "device_name": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "purpose": {
                    "anyOf": [
                      {
                        "anyOf": [
                          {
                            "type": "string",
                            "enum": [
                              "runtime"
                            ]
                          },
                          {
                            "type": "string",
                            "enum": [
                              "publish"
                            ]
                          }
                        ]
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "acquired_at": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "renewed_at": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "expires_at": {
                    "type": "integer"
                  }
                }
              },
              {
                "type": "null"
              }
            ]
          }
        }
      }
    }
  }
}
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": "Aktuelle Nutzung einer Team-Freigabe auf anderen Geräten",
  "tags": [
    "Team"
  ],
  "parameters": [
    {
      "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": [
              "profile_id",
              "lease"
            ],
            "properties": {
              "profile_id": {
                "type": "string"
              },
              "lease": {
                "anyOf": [
                  {
                    "type": "object",
                    "required": [
                      "member_id",
                      "member_name",
                      "email",
                      "device_id",
                      "device_name",
                      "purpose",
                      "acquired_at",
                      "renewed_at",
                      "expires_at"
                    ],
                    "properties": {
                      "member_id": {
                        "type": "string"
                      },
                      "member_name": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "email": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "device_id": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "device_name": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "purpose": {
                        "anyOf": [
                          {
                            "anyOf": [
                              {
                                "type": "string",
                                "enum": [
                                  "runtime"
                                ]
                              },
                              {
                                "type": "string",
                                "enum": [
                                  "publish"
                                ]
                              }
                            ]
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "acquired_at": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "renewed_at": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "expires_at": {
                        "type": "integer"
                      }
                    }
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            }
          }
        }
      }
    },
    "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