Item shares API

Base URL: https://YOUR-SERVER/api. Send your API key in x-api-key where authentication is required. A key also needs the listed permission; your account's access rules still apply.

API guide · All endpoints · OpenAPI JSON

• DELETE /item-shares — Stop sharing items with people
• POST /item-shares — Share items with people
• PUT /item-shares/query — List who items are shared with
• GET /item-shares/received — Items shared with you

Stop sharing items with people

DELETE /api/item-shares

Stop sharing your own items with these people. They lose access at once.

Authentication: API key. Permission: asset.share.

Request body

Required.

Field definitions: ItemShareChangeDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/ItemShareChangeDto"
    }
  }
}

Responses

Field definitions: ItemShareChangeResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ItemShareChangeResponseDto"
        }
      }
    },
    "description": ""
  }
}

Share items with people

POST /api/item-shares

Share your own items with people who have an account on this server. They see the items under Sharing, in their own library, and are notified. Locked items are refused.

Authentication: API key. Permission: asset.share.

Request body

Required.

Field definitions: ItemShareChangeDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/ItemShareChangeDto"
    }
  }
}

Responses

Field definitions: ItemShareChangeResponseDto

{
  "201": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ItemShareChangeResponseDto"
        }
      }
    },
    "description": ""
  }
}

List who items are shared with

PUT /api/item-shares/query

The people each of your own items is shared with.

Authentication: API key. Permission: asset.share.

Request body

Required.

Field definitions: ItemShareQueryDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/ItemShareQueryDto"
    }
  }
}

Responses

Field definitions: ItemShareResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "items": {
            "$ref": "#/components/schemas/ItemShareResponseDto"
          },
          "type": "array"
        }
      }
    },
    "description": ""
  }
}

Items shared with you

GET /api/item-shares/received

Items other people shared with you one by one, newest first. Items that are locked, trashed or no longer shared are left out.

Authentication: API key. Permission: asset.read.

Responses

Field definitions: ItemShareReceivedResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ItemShareReceivedResponseDto"
        }
      }
    },
    "description": ""
  }
}