Database - Corsair

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

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

Contacts

Path: campayn.db.contacts.search

const rows = await corsair.campayn.db.contacts.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
`email`	`string`	equals, contains, startsWith, endsWith, in
`first_name`	`string`	equals, contains, startsWith, endsWith, in
`last_name`	`string`	equals, contains, startsWith, endsWith, in
`title`	`string`	equals, contains, startsWith, endsWith, in
`company`	`string`	equals, contains, startsWith, endsWith, in
`address`	`string`	equals, contains, startsWith, endsWith, in
`country_id`	`string`	equals, contains, startsWith, endsWith, in
`country`	`string`	equals, contains, startsWith, endsWith, in
`city`	`string`	equals, contains, startsWith, endsWith, in
`state`	`string`	equals, contains, startsWith, endsWith, in
`zip`	`string`	equals, contains, startsWith, endsWith, in
`birthday`	`string`	equals, contains, startsWith, endsWith, in
`tags`	`string`	equals, contains, startsWith, endsWith, in
`image_url`	`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.

Lists

Path: campayn.db.lists.search

const rows = await corsair.campayn.db.lists.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
`list_name`	`string`	equals, contains, startsWith, endsWith, in
`tags`	`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.

Messages

Path: campayn.db.messages.search

const rows = await corsair.campayn.db.messages.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
`scheduled_date`	`string`	equals, contains, startsWith, endsWith, in
`campaign_title`	`string`	equals, contains, startsWith, endsWith, in
`status`	`string`	equals, contains, startsWith, endsWith, in
`preview_url`	`string`	equals, contains, startsWith, endsWith, in
`preview_thumb`	`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.

Reports

Path: campayn.db.reports.search

const rows = await corsair.campayn.db.reports.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
`scheduled_date`	`string`	equals, contains, startsWith, endsWith, in
`status`	`string`	equals, contains, startsWith, endsWith, in
`preview_url`	`string`	equals, contains, startsWith, endsWith, in
`report_url`	`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.

Webforms

Path: campayn.db.webforms.search

const rows = await corsair.campayn.db.webforms.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
`contact_list_id`	`string`	equals, contains, startsWith, endsWith, in
`form_title`	`string`	equals, contains, startsWith, endsWith, in
`form_type`	`string`	equals, contains, startsWith, endsWith, in
`form_html`	`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.