Manage Applications

    File

    A full representation of a file, as can be returned from any file API endpoints by default

    Base
    Mini
    Standard

    This resource has a few variations that can be encountered when using the API.

    The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

    string
    1

    The HTTP etag of this file. This can be used within some API endpoints in the If-Match and If-None-Match headers to only perform changes on the file if (no) changes have happened.

    string
    12345

    The unique identifier that represent a file.

    The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the url https://*.app.box.com/files/123 the file_id is 123.

    string
    file

    Value is always "file"

    string
    Contract.pdf

    The name of the file

    3

    A numeric identifier that represents the most recent user event that has been applied to this item.

    This can be used in combination with the GET /events-endpoint to filter out user events that would have occurred before this identifier was read.

    A simple example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the sequence_id in the event is smaller than or equal to the sequence_id in the originally fetched resource.

    ["open"]

    A list of the types of roles that user can be invited at when sharing this file.

    Value is any of "editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", "co-owner"

    string / date-time
    2012-12-12T10:53:43-08:00

    The date and time at which this file was originally created, which might be before it was uploaded to Box.

    string / date-time
    2012-12-12T10:53:43-08:00

    The date and time at which this folder was last updated, which might be before it was uploaded to Box.

    string / date-time
    2012-12-12T10:53:43-08:00

    The date and time when the file was created on Box.

    The user who created this file

    Contract for Q1 renewal256

    The optional description of this file

    true

    Specifies if this folder has any other collaborators.

    true

    Specifies if this folder is owned by a user outside of the authenticated enterprise.

    active

    Defines if this item has been deleted or not.

    • active when the item has is not in the trash
    • trashed when the item has been moved to the trash but not deleted
    • deleted when the item has been permanently deleted.

    Value is one of "active", "trashed", "deleted"

    string / date-time
    2012-12-12T10:53:43-08:00

    The date and time when the folder was last updated on Box.

    The user who last modified this file

    The user who owns this file

    The folder that this file is located within.

    The tree of folders that this file is contained in, starting at the root.

    string / date-time
    2012-12-12T10:53:43-08:00

    The time at which this file is expected to be purged from the trash.

    string / digest
    85136C79CBF9FE36BB9D05D0639C70C265C18D37

    The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file.

    integer
    629644

    The file size in bytes. Be careful parsing this integer, it can easily get very large and cause an integer overflow.

    string array
    ["approved"]

    The tags for this item. These tags are shown in the Box web app and mobile apps next to an item.

    To add or remove a tag, retrieve the item's current tags, modify them, and then update this field.

    There is a limit of 100 tags per item, and 10,000 unique tags per enterprise.

    string / date-time
    2012-12-12T10:53:43-08:00

    The time at which this file was put in the trash.

    Full

    Response Example

    {
      "id": 12345,
      "etag": 1,
      "type": "file",
      "sequence_id": 3,
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "description": "Contract for Q1 renewal",
      "size": 629644,
      "path_collection": {
        "total_count": 1,
        "entries": [
          {
            "id": 12345,
            "etag": 1,
            "type": "folder",
            "sequence_id": 3,
            "name": "Contracts"
          }
        ]
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "trashed_at": "2012-12-12T10:53:43-08:00",
      "purged_at": "2012-12-12T10:53:43-08:00",
      "content_created_at": "2012-12-12T10:53:43-08:00",
      "content_modified_at": "2012-12-12T10:53:43-08:00",
      "created_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "modified_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "owned_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "shared_link": {
        "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
        "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
        "vanity_url": "https://acme.app.box.com/v/my_url/",
        "access": "open",
        "effective_access": "company",
        "effective_permission": "can_download",
        "unshared_at": "2018-04-13T13:53:23-07:00",
        "is_password_enabled": true,
        "permissions": {
          "can_download": true,
          "can_preview": true
        },
        "download_count": 3,
        "preview_count": 3
      },
      "parent": {
        "id": 12345,
        "etag": 1,
        "type": "folder",
        "sequence_id": 3,
        "name": "Contracts"
      },
      "item_status": "active",
      "version_number": 1,
      "comment_count": 10,
      "permissions": {
        "can_delete": true,
        "can_download": true,
        "can_invite_collaborator": true,
        "can_rename": true,
        "can_set_share_access": true,
        "can_share": true,
        "can_annotate": true,
        "can_comment": true,
        "can_preview": true,
        "can_upload": true,
        "can_view_annotations_all": true,
        "can_view_annotations_self": true
      },
      "tags": [
        "approved"
      ],
      "lock": {
        "id": 11446498,
        "type": "lock",
        "created_by": {
          "id": 11446498,
          "type": "user",
          "name": "Aaron Levie",
          "login": "ceo@example.com"
        },
        "created_at": "2012-12-12T10:53:43-08:00",
        "expired_at": "2012-12-12T10:53:43-08:00",
        "is_download_prevented": true
      },
      "extension": "pdf",
      "is_package": true,
      "expiring_embed_link": {
        "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
        "expires_in": 3600,
        "token_type": "bearer",
        "restricted_to": [
          {
            "scope": "item_download",
            "object": {
              "id": 12345,
              "etag": 1,
              "type": "file",
              "sequence_id": 3,
              "name": "Contract.pdf"
            }
          }
        ],
        "url": "https://cloud.app.box.com/preview/expiring_embed/..."
      },
      "watermark_info": {
        "is_watermarked": true
      },
      "allowed_invitee_roles": [
        "open"
      ],
      "is_externally_owned": true,
      "has_collaborations": true,
      "metadata": {
        "global": {
          "marketingCollateral": {
            "$canEdit": true,
            "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
            "$parent": "folder_59449484661",
            "$scope": "enterprise_27335",
            "$template": "blueprintTemplate",
            "$type": "blueprintTemplate-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
            "$typeVersion": 2,
            "$version": 1
          }
        }
      },
      "expires_at": "2012-12-12T10:53:43-08:00",
      "representations": {
        "entries": [
          {
            "content": {
              "url_template": "https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567"
            },
            "info": {
              "url": "https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048"
            },
            "properties": {
              "dimensions": "2048x2048",
              "paged": true,
              "thumb": true
            },
            "representation": "png",
            "status": {
              "state": "success"
            }
          }
        ]
      }
    }