Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Channels

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

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
namestringequals, contains, startsWith, endsWith, in
name_normalizedstringequals, contains, startsWith, endsWith, in
is_channelbooleanequals
is_groupbooleanequals
is_imbooleanequals
is_mpimbooleanequals
is_privatebooleanequals
is_archivedbooleanequals
is_generalbooleanequals
creatednumberequals, gt, gte, lt, lte, in
createdAtdateequals, before, after, between
creatorstringequals, contains, startsWith, endsWith, in
is_memberbooleanequals
num_membersnumberequals, gt, gte, lt, lte, 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.

​
Files

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

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
namestringequals, contains, startsWith, endsWith, in
titlestringequals, contains, startsWith, endsWith, in
mimetypestringequals, contains, startsWith, endsWith, in
filetypestringequals, contains, startsWith, endsWith, in
pretty_typestringequals, contains, startsWith, endsWith, in
userstringequals, contains, startsWith, endsWith, in
sizenumberequals, gt, gte, lt, lte, in
url_privatestringequals, contains, startsWith, endsWith, in
url_private_downloadstringequals, contains, startsWith, endsWith, in
permalinkstringequals, contains, startsWith, endsWith, in
permalink_publicstringequals, contains, startsWith, endsWith, in
creatednumberequals, gt, gte, lt, lte, in
timestampnumberequals, gt, gte, lt, lte, 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.

​
Messages

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

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
tsstringequals, contains, startsWith, endsWith, in
typestringequals, contains, startsWith, endsWith, in
subtypestringequals, contains, startsWith, endsWith, in
textstringequals, contains, startsWith, endsWith, in
userstringequals, contains, startsWith, endsWith, in
bot_idstringequals, contains, startsWith, endsWith, in
app_idstringequals, contains, startsWith, endsWith, in
teamstringequals, contains, startsWith, endsWith, in
usernamestringequals, contains, startsWith, endsWith, in
channelstringequals, contains, startsWith, endsWith, in
createdAtdateequals, before, after, between
authorIdstringequals, contains, startsWith, endsWith, in
thread_tsstringequals, contains, startsWith, endsWith, in
reply_countnumberequals, gt, gte, lt, lte, in
is_lockedbooleanequals
subscribedbooleanequals
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.

​
User Groups

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

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
namestringequals, contains, startsWith, endsWith, in
descriptionstringequals, contains, startsWith, endsWith, in
handlestringequals, contains, startsWith, endsWith, in
is_usergroupbooleanequals
date_createnumberequals, gt, gte, lt, lte, in
date_updatenumberequals, gt, gte, lt, lte, in
created_bystringequals, contains, startsWith, endsWith, in
user_countnumberequals, gt, gte, lt, lte, in
channel_countnumberequals, gt, gte, lt, lte, 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.

​
Users

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

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
namestringequals, contains, startsWith, endsWith, in
real_namestringequals, contains, startsWith, endsWith, in
display_namestringequals, contains, startsWith, endsWith, in
emailstringequals, contains, startsWith, endsWith, in
is_botbooleanequals
is_adminbooleanequals
deletedbooleanequals
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.