Query the files on a board
Regional
us.api.brault.app— follows the region selector in the top barA read expressed as POST because its filter is a JSON document. Returns board_file objects: the file, this board’s values for it, and when it was added. Trashed files are never listed.
Authorization
apiKey AuthorizationBearer <token>
API key from Settings → Developers
In: header
Path Parameters
boardId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/boards/string/query" \ -H "Content-Type: application/json" \ -d '{}'{ "object": "list", "has_more": true, "next_cursor": "string", "data": [ { "object": "board_file", "board_id": "string", "file": { "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" } }, "values": [ { "property_id": "string", "type": "status", "status": { "option_id": "string" }, "person": { "user_id": "string" }, "date": { "start": "2019-08-24T14:15:22Z" }, "checkbox": true, "text": "string", "multi_tag": [ { "option_id": "string" } ], "tag": [ { "option_id": "string" } ] } ], "added_at": "2019-08-24T14:15:22Z" } ]}