Brault Developers

List files

Regionalus.api.brault.appfollows the region selector in the top bar
GET
/v1/files

Files the key’s creator can see. Folders are never included. q runs the same keyword + natural-language search as the app and consumes the search rate bucket.

AuthorizationBearer <token>

API key from Settings → Developers

In: header

Query Parameters

limit?number
Range1 <= value <= 100
Default50
cursor?string

Opaque cursor from a previous response.

library_id?string
folder_id?string
recursive?boolean

Include files in every descendant folder.

Defaultfalse
q?string

Keyword and natural-language search. Consumes the search rate bucket.

Lengthlength <= 500
extensions?array<string>

Comma-separated extensions, without the dot.

kind?array<>
created_after?string
Formatdate-time
created_before?string
Formatdate-time
uploaded_by?array<string>

Comma-separated user ids.

min_size?number

Bytes.

max_size?number

Bytes.

filter?string

A URL-encoded JSON filter document (boards.md § 5). A condition may name a brandspace property or a board property; a board-property condition matches files through their membership on that property’s board. Combines with every other parameter with AND — which is why a top-level or filter cannot be sent together with uploaded_by, extensions, kind, min_size, max_size, created_after or created_before (400 validation_error).

Lengthlength <= 4096
sort?string
Default"created_at"

Value in

  • "name"
  • "size"
  • "created_at"
order?string
Default"desc"

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/files"
{  "object": "list",  "has_more": true,  "next_cursor": "string",  "data": [    {      "object": "file",      "id": "string",      "kind": "image",      "name": "string",      "extension": "string",      "mime": "string",      "size": 0,      "status": "processing",      "library_id": "string",      "folder_id": "string",      "external_url": "string",      "duration_ms": 0,      "resolution": "1920x1080",      "created_at": "2019-08-24T14:15:22Z",      "created_by_id": "string",      "trashed_at": "2019-08-24T14:15:22Z",      "thumbnail_url": "string",      "version": {        "count": 0,        "active_number": 0,        "active_id": "string"      }    }  ]}