Skip to content

Kirby 5.1.3

    Search by Algolia

    GET /api/site/files

    List files

    Query parameters

    Parameter Example Description
    limit ?limit=5 Limits the number of returned files.
    offset ?offset=10 Sets a manual offset. Use the page option together with limit for easier pagination.
    page ?page=2 Starts the collection at the given page. Only works when the limit is set.
    pretty ?pretty=true Pretty prints the result. Only useful for debugging.
    select ?select=filename,niceSize Defines the fields that will be returned for each file.

    File fields

    The following fields are available in the file model and can be fetched with the select parameter:

    • blueprint
    • content
    • dimensions
    • dragText
    • exists
    • extension
    • filename
    • id
    • link
    • mime
    • modified
    • name
    • next
    • nextWithTemplate
    • niceSize
    • options
    • panelImage
    • panelUrl
    • prev
    • prevWithTemplate
    • parent
    • parents
    • size
    • template
    • thumbs
    • type
    • url
    • uuid