Database - Corsair

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

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

Activity Call

Path: close.db.activityCall.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`lead_id`	`string`	equals, contains, startsWith, endsWith, in
`phone`	`string`	equals, contains, startsWith, endsWith, in
`direction`	`string`	equals, contains, startsWith, endsWith, in
`duration`	`number`	equals, gt, gte, lt, lte, in
`status`	`string`	equals, contains, startsWith, endsWith, in
`user_id`	`string`	equals, contains, startsWith, endsWith, in
`organization_id`	`string`	equals, contains, startsWith, endsWith, in
`date_created`	`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.

Activity Email

Path: close.db.activityEmail.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`lead_id`	`string`	equals, contains, startsWith, endsWith, in
`subject`	`string`	equals, contains, startsWith, endsWith, in
`body_text`	`string`	equals, contains, startsWith, endsWith, in
`sender`	`string`	equals, contains, startsWith, endsWith, in
`direction`	`string`	equals, contains, startsWith, endsWith, in
`user_id`	`string`	equals, contains, startsWith, endsWith, in
`organization_id`	`string`	equals, contains, startsWith, endsWith, in
`date_created`	`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.

Activity Note

Path: close.db.activityNote.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`lead_id`	`string`	equals, contains, startsWith, endsWith, in
`note`	`string`	equals, contains, startsWith, endsWith, in
`user_id`	`string`	equals, contains, startsWith, endsWith, in
`organization_id`	`string`	equals, contains, startsWith, endsWith, in
`date_created`	`string`	equals, contains, startsWith, endsWith, in
`date_updated`	`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.

Contact

Path: close.db.contact.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`lead_id`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`title`	`string`	equals, contains, startsWith, endsWith, in
`organization_id`	`string`	equals, contains, startsWith, endsWith, in
`created_by`	`string`	equals, contains, startsWith, endsWith, in
`date_created`	`string`	equals, contains, startsWith, endsWith, in
`date_updated`	`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

Path: close.db.customField.search

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

Searchable filters

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

Lead

Path: close.db.lead.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`status_id`	`string`	equals, contains, startsWith, endsWith, in
`status_label`	`string`	equals, contains, startsWith, endsWith, in
`description`	`string`	equals, contains, startsWith, endsWith, in
`url`	`string`	equals, contains, startsWith, endsWith, in
`organization_id`	`string`	equals, contains, startsWith, endsWith, in
`created_by`	`string`	equals, contains, startsWith, endsWith, in
`updated_by`	`string`	equals, contains, startsWith, endsWith, in
`date_created`	`string`	equals, contains, startsWith, endsWith, in
`date_updated`	`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.

Opportunity

Path: close.db.opportunity.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`lead_id`	`string`	equals, contains, startsWith, endsWith, in
`lead_name`	`string`	equals, contains, startsWith, endsWith, in
`status_id`	`string`	equals, contains, startsWith, endsWith, in
`status_label`	`string`	equals, contains, startsWith, endsWith, in
`status_type`	`string`	equals, contains, startsWith, endsWith, in
`value`	`number`	equals, gt, gte, lt, lte, in
`value_period`	`string`	equals, contains, startsWith, endsWith, in
`confidence`	`number`	equals, gt, gte, lt, lte, in
`user_id`	`string`	equals, contains, startsWith, endsWith, in
`organization_id`	`string`	equals, contains, startsWith, endsWith, in
`date_won`	`string`	equals, contains, startsWith, endsWith, in
`date_lost`	`string`	equals, contains, startsWith, endsWith, in
`date_created`	`string`	equals, contains, startsWith, endsWith, in
`date_updated`	`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

Path: close.db.task.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`lead_id`	`string`	equals, contains, startsWith, endsWith, in
`text`	`string`	equals, contains, startsWith, endsWith, in
`due_date`	`string`	equals, contains, startsWith, endsWith, in
`is_complete`	`boolean`	equals
`assigned_to`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`organization_id`	`string`	equals, contains, startsWith, endsWith, in
`created_by`	`string`	equals, contains, startsWith, endsWith, in
`date_created`	`string`	equals, contains, startsWith, endsWith, in
`date_updated`	`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.

User

Path: close.db.user.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`first_name`	`string`	equals, contains, startsWith, endsWith, in
`last_name`	`string`	equals, contains, startsWith, endsWith, in
`email`	`string`	equals, contains, startsWith, endsWith, in
`image`	`string`	equals, contains, startsWith, endsWith, in
`organization_id`	`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.