List sheets - HQ Rental Software

Returns a page of the account's forms (sheets), in the order set in the application. Archived forms are included unless you send filtered=1. Requires the Forms module.

Each row also has enable_steps, sheet_category and steps. For forms with steps, use a step id as step_id when you create or update sheet items.

Responses

🟢200OK

application/json

A page of forms. 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": 5,
            "label": "Damage reports",
            "icon": "fas fa-car-crash",
            "description": "Damage found at vehicle return",
            "uuid": "3b7c1d2e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
            "handle": "damage-reports",
            "enable_steps": false,
            "category_id": null,
            "created_at": "2025-01-09T03:01:49.000000Z",
            "public_permanent_link_url": "https://yourcompany.example.com/form/3b7c1d2e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
            "sheet_category": null,
            "steps": []
        }
    ],
    "first_page_url": "https://api.hqrentals.app/api/sheets?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.hqrentals.app/api/sheets?page=1",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "page": null,
            "active": false
        },
        {
            "url": "https://api.hqrentals.app/api/sheets?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/sheets",
    "per_page": 50,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

🟠400Bad Request