Database - Corsair

The Connecteam plugin syncs data locally. Use corsair.connecteam.db.<entity>.search({ data, limit?, offset? }) with the filters listed per entity.

New to Corsair? See database operations, data synchronization, and multi-tenancy.

Account

Path: connecteam.db.account.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`companyId`	`string`	equals, contains, startsWith, endsWith, in
`companyName`	`string`	equals, 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.

Conversations

Path: connecteam.db.conversations.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`title`	`string`	equals, 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.

Custom Field Categories

Path: connecteam.db.customFieldCategories.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, 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.

Custom Fields

Path: connecteam.db.customFields.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`categoryId`	`number`	equals, gt, gte, lt, lte, in
`isRequired`	`boolean`	equals
`isVisibleToAllAdmins`	`boolean`	equals
`isEditableForAllAdmins`	`boolean`	equals
`isVisibleToUsers`	`boolean`	equals
`isEditableForUsers`	`boolean`	equals
`isMultiSelect`	`boolean`	equals

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.

Forms

Path: connecteam.db.forms.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`formId`	`number`	equals, gt, gte, lt, lte, in
`formName`	`string`	equals, contains, startsWith, endsWith, in
`createdAt`	`number`	equals, gt, gte, lt, lte, in
`lastUpdatedAt`	`number`	equals, 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.

Jobs

Path: connecteam.db.jobs.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`jobId`	`string`	equals, contains, startsWith, endsWith, in
`title`	`string`	equals, contains, startsWith, endsWith, in
`code`	`string`	equals, contains, startsWith, endsWith, in
`color`	`string`	equals, contains, startsWith, endsWith, in
`description`	`string`	equals, contains, startsWith, endsWith, in
`isDeleted`	`boolean`	equals
`useParentData`	`boolean`	equals

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.

Performance Indicators

Path: connecteam.db.performanceIndicators.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, 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.

Policy Types

Path: connecteam.db.policyTypes.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, 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.

Publishers

Path: connecteam.db.publishers.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`number`	equals, gt, gte, lt, lte, in
`publisherId`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, 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.

Schedulers

Path: connecteam.db.schedulers.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`schedulerId`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`isArchived`	`boolean`	equals
`timezone`	`string`	equals, 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.

Smart Groups

Path: connecteam.db.smartGroups.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`number`	equals, gt, gte, lt, lte, in
`smartGroupId`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`groupSegmentId`	`number`	equals, gt, gte, lt, lte, in
`description`	`string`	equals, 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.

Task Boards

Path: connecteam.db.taskBoards.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`taskBoardId`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`title`	`string`	equals, contains, startsWith, endsWith, in
`isArchived`	`boolean`	equals

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: connecteam.db.users.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`userId`	`number`	equals, gt, gte, lt, lte, in
`firstName`	`string`	equals, contains, startsWith, endsWith, in
`lastName`	`string`	equals, contains, startsWith, endsWith, in
`phoneNumber`	`string`	equals, contains, startsWith, endsWith, in
`userType`	`string`	equals, contains, startsWith, endsWith, in
`email`	`string`	equals, contains, startsWith, endsWith, in
`isArchived`	`boolean`	equals
`kioskCode`	`string`	equals, contains, startsWith, endsWith, in
`createdAt`	`number`	equals, gt, gte, lt, lte, in
`modifiedAt`	`number`	equals, gt, gte, lt, lte, in
`archivedAt`	`number`	equals, gt, gte, lt, lte, in
`lastLogin`	`number`	equals, gt, gte, lt, lte, in
`invitedToBeManager`	`boolean`	equals
`profilePictureUrl`	`string`	equals, contains, startsWith, endsWith, in
`mobileDevice`	`string`	equals, contains, startsWith, endsWith, in
`osVersion`	`string`	equals, contains, startsWith, endsWith, in
`appVersion`	`string`	equals, contains, startsWith, endsWith, in
`mobileDeviceId`	`string`	equals, 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.