Get a single share


Get a single share identified by shareId.

Endpoint URL: {service.share.url} received in EndpointFetching

Request Syntax

GET /v1/shares/{shareId}

Request Headers

Parameter Description Required
Authorization The authorized access token in the format "Bearer bb23e25a-f51d-44b6-b8d9-a669e5d4c01e". If the share retrieved is not public then the user must be a valid user.

Value of type: string
correlationID Used for logging/analytics tracking.

Value of type: string

Request Path Parameters

Parameter Description Required
shareId The shareId of the share to be retrieved.

Value of type: string

200 Response


Response Headers

Parameter Description Required
Access-Control-Allow-Origin Indicates whether the response can be shared with resources with the given origin.

Value of type: string

Response Payload

Parameter Description Required
data Object of type: GetShareResponse false
error A successful response will return a 200 HTTP status code with null in error response.

An unsuccessful response will return a 4xx HTTP status code. An example of an unsuccessful request would be when a share could not be found and you would get the following response body in addition to a 404 HTTP status code.

{ "data": null, "error": { "label": "SHARE_NOT_FOUND", "message": "404 Not Found Could not find share", } }

Possible HTTP response codes, error labels, and messages:

* 400, `GENERAL_INSUFFICIENT_PARAMETERS`, "400 Bad Request Required parameter _{parameter name}_ not present, invalid or empty"

Value of type: object

message Description

Value of type: string


Sample request to get a share identified by shareId.


GET shares/v1/shares/{shareId} HTTP/1.1
Host: Endpoint-URL
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Content-Type: application/json


HTTP/1.1 200 OK
  "data": {
    "lastModified": 1476834055308,
    "deviceId": "12345",
    "shareId": "12345",
    "fileIds": [
    "authId": "123456789",
    "useCache": true,
    "cacheUrl": "",
    "url": "",
    "ownerId": "123",
    "dateCreated": 1476834055308,
    "device": {}

  "error": null

Have question about this section?