Box · Example Payload

Box Get Web Links Idget Shared Link Example

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Box Get Web Links Idget Shared Link Example is an example object payload from Box, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "get_web_links_id#get_shared_link",
  "method": "GET",
  "path": "/web_links/{web_link_id}#get_shared_link",
  "summary": "Box Get shared link for web link",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "default",
      "example": {
        "id": "12345",
        "type": "web_link",
        "etag": "1",
        "shared_link": {
          "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
          "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
          "vanity_url": null,
          "vanity_name": null,
          "effective_access": "open",
          "effective_permission": "can_download",
          "is_password_enabled": false,
          "unshared_at": "2020-09-21T10:34:41-07:00",
          "download_count": 0,
          "preview_count": 0,
          "access": "open",
          "permissions": {
            "can_preview": true,
            "can_download": true,
            "can_edit": false
          }
        }
      }
    }
  ]
}