FIfiles
bundle_downloads
Bundle Downloads

List Share Link Downloads

Changed on

List Share Link Downloads

get/bundle_downloads

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/bundle_downloads
  • Auth
    none declared

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id and created_at.

If set, return records where the specified field is equal to the supplied value. Valid fields are created_at.

If set, return records where the specified field is greater than the supplied value. Valid fields are created_at.

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at.

bundle_idinteger

Bundle ID

bundle_registration_idinteger

BundleRegistration ID

Response

A list of BundleDownloads objects.

download_method'file' | 'full_zip'

Download method (file or full_zip)

pathstring

Download path

workspace_idinteger

Workspace ID. 0 means the default workspace.

created_atstring date-time

Download date/time

Example response

[
  {
    "bundle_registration": {
      "code": "abc123",
      "name": "account",
      "company": "Action Verb",
      "email": "john.doe@files.com",
      "ip": "10.1.1.1",
      "inbox_code": "abc123",
      "clickwrap_body": "example",
      "form_field_set_id": 1,
      "form_field_data": {
        "key": "example value"
      },
      "bundle_code": "example",
      "bundle_id": 1,
      "bundle_recipient_id": 1,
      "workspace_id": 1,
      "created_at": "2000-01-01T01:00:00Z"
    },
    "download_method": "file",
    "path": "a/b/test.txt",
    "workspace_id": 1,
    "created_at": "2000-01-01T01:00:00Z"
  }
]

Changes

  • 3bb8c8a06041Revision changes
    • info

      api tag Bundle Downloads added

    • info

      added the new optional query request parameter filter

    • info

      added the new optional query request parameter filter_gt

    • info

      added the new optional query request parameter filter_gteq

    • info

      added the new optional query request parameter filter_lt

    • info

      added the new optional query request parameter filter_lteq

    • info

      added the new optional query request parameter sort_by

  • 334e0cf90234Revision changes
    • info

      endpoint added