List files of a record

Returns a page of the files attached to a record, such as a reservation, a vehicle, a contact or a sheet item. Deleted files are not returned.

Common item_type values: car_rental.reservations (with a reservation ID), fleets.vehicles (with a vehicle ID), contacts,contacts.{category_id} (with a contact ID), sheets.{sheet_id} (with a sheet item ID). For contacts, send both types: files in a folder shared by all contact categories are stored as contacts, so contacts.{category_id} alone misses them.

created_at and updated_at are shifted to your API user's time zone (see Dates, time zones and money) although they end in Z.

Responses

🟢200OK

application/json

A page of files. A successful body has no success field. HTTP 200 is also used for failures: such a body has success: false and is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "current_page": 1,
    "data": [
        {
            "id": 901,
            "uuid": "7d3e9a10-4b2c-4f5e-8a6b-9c0d1e2f3a4b",
            "filename": "license.jpg",
            "extension": "jpg",
            "mime": "image/jpeg",
            "size": 248113,
            "label": "license",
            "item_type": "contacts.3",
            "item_id": 1532,
            "field_id": 252,
            "folder_id": 0,
            "order": 0,
            "public_link": "https://yourcompany.example.com/files/7d3e9a10-4b2c-4f5e-8a6b-9c0d1e2f3a4b/public?timestamp=1791501538",
            "public_download_link": "https://yourcompany.example.com/files/7d3e9a10-4b2c-4f5e-8a6b-9c0d1e2f3a4b/download",
            "created_by": 2,
            "updated_by": 2,
            "created_at": "2026-10-08T23:18:58.000000Z",
            "updated_at": "2026-10-08T23:18:58.000000Z",
            "deleted_at": null
        }
    ],
    "first_page_url": "https://api.hqrentals.app/api/files?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.hqrentals.app/api/files?page=1",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "page": null,
            "active": false
        },
        {
            "url": "https://api.hqrentals.app/api/files?page=1",
            "label": "1",
            "page": 1,
            "active": true
        },
        {
            "url": null,
            "label": "Next &raquo;",
            "page": null,
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "https://api.hqrentals.app/api/files",
    "per_page": 10,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

Request

Responses