Files

List files

Returns list of webhook details. Query parameters can be used to optimize the response.

get/workspaces/{workspace_id}/projects/{project_id}/files

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/workspaces/{workspace_id}/projects/{project_id}/files
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4
project_idinteger required

Project ID of the workspace

Example:4

Query parameters

fieldsstring nullable

Fields to be returned in a comma-separated format may include id, name, status_info, created_at.

Example:id,name
idstring

Track multiple file ids, comma separated

Example:1,2,3
namestring nullable

Track multiple file names, comma separated

Example:file_name1,file_name2,file_name3
statusstring nullable

Track multiple file statuses, comma separated

Example:processing,action_needed
created_atstring nullable

Track multiple files, which falls under created_at date range

Example:(from:'2023-12-19T09:39:17.628Z',to:'2023-12-26T09:42:43.152Z')
updated_atstring nullable

Track multiple files, which falls under updated_at date range

Example:(from:'2023-12-19T09:39:17.628Z',to:'2023-12-26T09:42:43.152Z')
limitinteger

Max number of result to return

Example:10
offsetinteger

Distance from the beginning of the list of results

Example:10
sortstring nullable

Sort the files based on the fields

Example:(id:asc),(name:asc)
extensionstring nullable

Case-insensitive file extension to filter files by, with or without a leading dot

Example:pdf

Response

List files

limitinteger
offsetinteger
nextstring required

Example response

{
  "files": [
    {
      "status_info": {
        "value": {
          "action_needed": "requires_password",
          "is_hidden": false,
          "is_empty": false
        }
      },
      "additional_info": {
        "value": {
          "parent_id": "label_8024",
          "delete_existing_after_append": false,
          "password_protected": true,
          "sheet_info": {}
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.