Sign in

v1

latestOpenAPI 3.0.02026-07-145965251.1 KB
Shares

Get a share

Get the details for a specific share entry. You can use the include parameter to also get the details of related records, such as the owning user or the resources involved in the share.

Notes:

  • Authenticated user requires share permission.
  • To get share objects with type send, authenticated user's role must be admin or master.
get/shares/{id}

Query parameters

includestring

Comma separated list of relationships to include in response. Possible values are owner, resources, notifications, activity.

Headers

ev-api-keystring required
Example:exampleaccount-zwSuWUZ8S38h33qPS8v0s

API Key

ev-access-tokenstring required
Example:19853ef63a0bc348024a9e4cfd4a92520d2dfd04e88d8679fb1ed6bc551593d1

Access Token

Response

Successful operation

responseStatusinteger

Http status code of the response.

Example response

{
  "data": {
    "attributes": {
      "accessDescription": "Download only",
      "created": "2017-01-28T13:10:47Z",
      "hash": "hd1e-3erufo72",
      "messages": [
        {
          "body": "You have files available for download.",
          "created": "2017-01-26T18:10:47Z",
          "id": 397584,
          "modified": "2017-01-28T13:10:47Z",
          "shareId": 3544253,
          "subject": "Files available for download",
          "userId": 119394
        }
      ],
      "name": "Example Folder",
      "ownerHash": "hd1e-3erufo72-fsxak999",
      "paths": [
        "/Example Folder"
      ],
      "public": true,
      "recipients": [
        {
          "created": "2017-04-21T10:53:47Z",
          "email": "recipient@example.com",
          "hash": "fseowxan",
          "id": 2,
          "received": false,
          "sent": true,
          "shareId": 23,
          "type": "direct"
        }
      ],
      "requireEmail": true,
      "status": 1,
      "type": "shared_folder"
    },
    "id": 655621,
    "relationships": {
      "messages": [
        {
          "data": {
            "id": 21,
            "type": "message"
          }
        }
      ],
      "notifications": [
        {
          "data": {
            "id": 9,
            "type": "notification"
          }
        }
      ],
      "owner": {
        "data": {
          "id": 12345
        }
      },
      "resources": [
        {
          "data": {
            "id": 12345,
            "type": "resource"
          }
        }
      ]
    },
    "type": "share"
  },
  "included": [
    {
      "attributes": {
        "accessTimestamp": "2011-03-21T00:18:56-07:00",
        "accountName": "exampleaccount",
        "created": "2018-07-27T15:43:55-07:00",
        "email": "example@exavault.mail",
        "expiration": "2020-06-30T13:33:30-07:00",
        "homePath": "/",
        "modified": "2018-07-29T15:43:55-07:00",
        "nickname": "exampleuser",
        "role": "user",
        "status": 1,
        "timeZone": "America/Chicago",
        "username": "exampleuser"
      },
      "id": 655621,
      "relationships": {
        "homeResource": {
          "data": {
            "type": "resource"
          }
        },
        "ownerAccount": {
          "data": {
            "type": "account"
          }
        }
      },
      "type": "user"
    }
  ],
  "responseStatus": 200
}