List Files | whizboard | Documentation

{
  "data": {
    "items": [
      {
        "id": 1,
        "name": "string",
        "owner": {
          "id": 1,
          "name": "string",
          "email": "string"
        },
        "last_modified": "2024-01-15T09:30:00Z",
        "size": 1,
        "mime_type": "string",
        "status": "PENDING",
        "store_link": "string",
        "shared_with": [
          {
            "id": 1,
            "name": "string",
            "email": "string",
            "permission_type": "string"
          }
        ],
        "labels": [
          {
            "id": 1,
            "label": "string",
            "color": "string",
            "created_at": "2024-01-15T09:30:00Z",
            "updated_at": "2024-01-15T09:30:00Z"
          }
        ]
      }
    ],
    "page": 1,
    "page_size": 1,
    "total": 1,
    "total_pages": 1
  },
  "status": "success"
}

List files for a firm with pagination, filters, search, and sorting.

Firm filtering is enforced by the {firm_slug} path and membership check.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

firm_slugstringRequired3-64 characters

Query parameters

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

searchstring or nullOptional>=1 character

Search by file name

typestring or nullOptional>=1 character

MIME type filter. Supports exact or partial values.

mime_typestring or nullOptional>=1 character

statusenum or nullOptional

Lifecycle status for a file upload/processing pipeline.

Shared between:

FileMetadata.status (overall file)
FileChunk.status (each uploaded chunk)

ownerstring or nullOptional>=1 character

Owner name, email, or numeric user id

owner_idinteger or nullOptional>=1

shared_with_user_idinteger or nullOptional>=1

Filter files shared with a firm member user id

accessible_to_user_idinteger or nullOptional>=1

Filter files either owned by this user or shared with this user

label_idslist of integersOptionalDefaults to []

Filter by label ids. Repeat label_ids or pass multiple values.

label_matchenumOptionalDefaults to any

Allowed values:

modified_fromdatetime or nullOptional

modified_todatetime or nullOptional

include_deletedbooleanOptionalDefaults to false

include_chat_uploadsbooleanOptionalDefaults to false

sort_byenumOptionalDefaults to last_modified

sort_orderenumOptionalDefaults to desc

Allowed values:

Response

Successful Response

dataobject

statusstringOptionalDefaults to success

Errors

422

Unprocessable Entity Error