Database - Corsair

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

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

Calls

Path: callingly.db.calls.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`started_at`	`string`	equals, contains, startsWith, endsWith, in
`direction`	`string`	equals, contains, startsWith, endsWith, in
`status`	`string`	equals, contains, startsWith, endsWith, in
`status_formatted`	`string`	equals, contains, startsWith, endsWith, in
`lead_status`	`string`	equals, contains, startsWith, endsWith, in
`lead_status_formatted`	`string`	equals, contains, startsWith, endsWith, in
`ring_status`	`string`	equals, contains, startsWith, endsWith, in
`seconds`	`number`	equals, gt, gte, lt, lte, in
`duration`	`string`	equals, contains, startsWith, endsWith, in
`retry`	`number`	equals, gt, gte, lt, lte, in
`lead_retry`	`number`	equals, gt, gte, lt, lte, in
`time_formatted`	`string`	equals, contains, startsWith, endsWith, in
`from_formatted`	`string`	equals, contains, startsWith, endsWith, in
`source`	`string`	equals, contains, startsWith, endsWith, in
`recording_url`	`string`	equals, contains, startsWith, endsWith, in
`waveform_url`	`string`	equals, contains, startsWith, endsWith, in
`error_message`	`string`	equals, contains, startsWith, endsWith, in
`phone_number_formatted`	`string`	equals, contains, startsWith, endsWith, in
`human_result`	`string`	equals, contains, startsWith, endsWith, in
`is_voicemail`	`number`	equals, gt, gte, lt, lte, in
`is_queue`	`number`	equals, gt, gte, lt, lte, in
`is_team_offline`	`number`	equals, gt, gte, lt, lte, in
`scheduled_call_type`	`string`	equals, contains, startsWith, endsWith, in
`transcript`	`string`	equals, contains, startsWith, endsWith, in
`is_error`	`number`	equals, gt, gte, lt, lte, in
`error_code`	`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.

Clients

Path: callingly.db.clients.search

const rows = await corsair.callingly.db.clients.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
`email`	`string`	equals, contains, startsWith, endsWith, in
`billing_email`	`string`	equals, contains, startsWith, endsWith, in
`billed_users`	`number`	equals, gt, gte, lt, lte, in
`billed_numbers`	`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.

Leads

Path: callingly.db.leads.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`fname`	`string`	equals, contains, startsWith, endsWith, in
`lname`	`string`	equals, contains, startsWith, endsWith, in
`email`	`string`	equals, contains, startsWith, endsWith, in
`phone_number`	`string`	equals, contains, startsWith, endsWith, in
`source`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`company`	`string`	equals, contains, startsWith, endsWith, in
`category`	`string`	equals, contains, startsWith, endsWith, in
`status`	`string`	equals, contains, startsWith, endsWith, in
`result`	`string`	equals, contains, startsWith, endsWith, in
`stage`	`string`	equals, contains, startsWith, endsWith, in
`scheduled_call_at`	`string`	equals, contains, startsWith, endsWith, in
`is_stopped`	`number`	equals, gt, gte, lt, lte, in
`is_blocked`	`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.

Schedules

Path: callingly.db.schedules.search

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

Searchable filters

Field	Type	Operators
`entity_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.

Teams

Path: callingly.db.teams.search

const rows = await corsair.callingly.db.teams.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
`call_mode`	`string`	equals, contains, startsWith, endsWith, in
`whispertext`	`string`	equals, contains, startsWith, endsWith, in
`post_whispertext`	`string`	equals, contains, startsWith, endsWith, in
`language`	`string`	equals, contains, startsWith, endsWith, in
`delay`	`number`	equals, gt, gte, lt, lte, in
`retries`	`number`	equals, gt, gte, lt, lte, in
`lead_retries`	`number`	equals, gt, gte, lt, lte, in
`sms_body`	`string`	equals, contains, startsWith, endsWith, in
`whispertext_voice`	`string`	equals, contains, startsWith, endsWith, in
`is_users_available_for_call`	`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.

Team Users

Path: callingly.db.teamUsers.search

const rows = await corsair.callingly.db.teamUsers.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
`priority`	`number`	equals, gt, gte, lt, lte, in
`cap`	`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.

Users

Path: callingly.db.users.search

const rows = await corsair.callingly.db.users.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
`fname`	`string`	equals, contains, startsWith, endsWith, in
`lname`	`string`	equals, contains, startsWith, endsWith, in
`email`	`string`	equals, contains, startsWith, endsWith, in
`phone_number`	`string`	equals, contains, startsWith, endsWith, in
`ext`	`string`	equals, contains, startsWith, endsWith, in
`donotdisturb_until`	`string`	equals, contains, startsWith, endsWith, in
`priority`	`number`	equals, gt, gte, lt, lte, in
`timezone`	`string`	equals, contains, startsWith, endsWith, in
`is_available`	`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.

Webhooks

Path: callingly.db.webhooks.search

const rows = await corsair.callingly.db.webhooks.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
`event`	`string`	equals, contains, startsWith, endsWith, in
`target_url`	`string`	equals, contains, startsWith, endsWith, in
`direction`	`string`	equals, contains, startsWith, endsWith, in
`call_direction`	`string`	equals, contains, startsWith, endsWith, in
`call_status`	`string`	equals, contains, startsWith, endsWith, in
`call_lead_status`	`string`	equals, contains, startsWith, endsWith, in
`field`	`string`	equals, contains, startsWith, endsWith, in
`filter`	`string`	equals, contains, startsWith, endsWith, in
`consecutive_failures`	`number`	equals, gt, gte, lt, lte, in
`last_failed_at`	`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.