List File Shares | whizboard

{
  "data": {
    "items": [
      {
        "id": 1,
        "file": {
          "id": 1,
          "name": "string",
          "status": "PENDING",
          "mime_type": "string",
          "size": 1
        },
        "shared_with": {
          "id": 1,
          "name": "string",
          "email": "string"
        },
        "shared_by": {
          "id": 1,
          "name": "string",
          "email": "string"
        },
        "permission_type": "string",
        "created_at": "2024-01-15T09:30:00Z"
      }
    ],
    "page": 1,
    "page_size": 1,
    "total": 1,
    "total_pages": 1
  },
  "status": "success"
}

List file shares for the current firm.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

firm_slugstringRequired3-64 characters

Query parameters

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

file_idinteger or nullOptional>=1

shared_with_user_idinteger or nullOptional>=1

include_deletedbooleanOptionalDefaults to false

Response

Successful Response

dataobject

statusstringOptionalDefaults to success

Errors

422

Unprocessable Entity Error