Shares

Retrieve a share object

post/shares.info

Request body

idstring uuid

Unique identifier for the share.

documentIdstring uuid

Unique identifier for a document. One of id or documentId must be provided.

Response

OK

Example response

{
  "data": {
    "documentTitle": "React best practices",
    "includeChildDocuments": true,
    "createdBy": {
      "name": "Jane Doe"
    }
  }
}

Changes

Changed in 2 of the 6 revisions of this API.10

    • added the non-success response with the status 429

      response-non-success-status-added

    • added the optional property data to the response with the 401 status

      response-optional-property-added

    • added the optional property data to the response with the 403 status

      response-optional-property-added

    • added the optional property data to the response with the 404 status

      response-optional-property-added

    • added the optional property message to the response with the 401 status

      response-optional-property-added

    • added the optional property message to the response with the 403 status

      response-optional-property-added

    • added the optional property message to the response with the 404 status

      response-optional-property-added

    • added the optional property status to the response with the 401 status

      response-optional-property-added

    • added the optional property status to the response with the 403 status

      response-optional-property-added

    • added the optional property status to the response with the 404 status

      response-optional-property-added