Skip to main content
The Box plugin syncs data locally. Use corsair.box.db.<entity>.search({ data, limit?, offset? }) with the filters listed per entity.
New to Corsair? See database operations, data synchronization, and multi-tenancy.

​
Files

Path: box.db.files.search 
const rows = await corsair.box.db.files.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
typestringequals, contains, startsWith, endsWith, in
namestringequals, contains, startsWith, endsWith, in
sizenumberequals, gt, gte, lt, lte, in
descriptionstringequals, contains, startsWith, endsWith, in
etagstringequals, contains, startsWith, endsWith, in
sha1stringequals, contains, startsWith, endsWith, in
sequence_idstringequals, contains, startsWith, endsWith, in
extensionstringequals, contains, startsWith, endsWith, in
is_packagebooleanequals
content_created_atstringequals, contains, startsWith, endsWith, in
content_modified_atstringequals, contains, startsWith, endsWith, in
created_atstringequals, contains, startsWith, endsWith, in
modified_atstringequals, contains, startsWith, endsWith, in
trashed_atstringequals, contains, startsWith, endsWith, in
purged_atstringequals, contains, startsWith, endsWith, in
item_statusstringequals, contains, startsWith, endsWith, in
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

​
Folders

Path: box.db.folders.search 
const rows = await corsair.box.db.folders.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
typestringequals, contains, startsWith, endsWith, in
namestringequals, contains, startsWith, endsWith, in
descriptionstringequals, contains, startsWith, endsWith, in
etagstringequals, contains, startsWith, endsWith, in
sequence_idstringequals, contains, startsWith, endsWith, in
created_atstringequals, contains, startsWith, endsWith, in
modified_atstringequals, contains, startsWith, endsWith, in
trashed_atstringequals, contains, startsWith, endsWith, in
purged_atstringequals, contains, startsWith, endsWith, in
content_created_atstringequals, contains, startsWith, endsWith, in
content_modified_atstringequals, contains, startsWith, endsWith, in
is_externally_ownedbooleanequals
has_collaborationsbooleanequals
item_statusstringequals, contains, startsWith, endsWith, in
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.