Database

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

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

Accounts

Path: faraday.db.accounts.search

const rows = await corsair.faraday.db.accounts.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
`resource_type`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`string`	equals, contains, startsWith, endsWith, in
`archived_at`	`string`	equals, contains, startsWith, endsWith, in
`status_changed_at`	`string`	equals, contains, startsWith, endsWith, in
`status_error`	`string`	equals, contains, startsWith, endsWith, in
`last_read_input_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_config_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_output_at`	`string`	equals, contains, startsWith, endsWith, in
`contract_started_at`	`string`	equals, contains, startsWith, endsWith, in
`parent_account_id`	`string`	equals, contains, startsWith, endsWith, in
`stripe_customer_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.

Cohorts

Path: faraday.db.cohorts.search

const rows = await corsair.faraday.db.cohorts.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
`resource_type`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`string`	equals, contains, startsWith, endsWith, in
`archived_at`	`string`	equals, contains, startsWith, endsWith, in
`status_changed_at`	`string`	equals, contains, startsWith, endsWith, in
`status_error`	`string`	equals, contains, startsWith, endsWith, in
`last_read_input_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_config_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_output_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.

Connections

Path: faraday.db.connections.search

const rows = await corsair.faraday.db.connections.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
`resource_type`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`string`	equals, contains, startsWith, endsWith, in
`archived_at`	`string`	equals, contains, startsWith, endsWith, in
`status_changed_at`	`string`	equals, contains, startsWith, endsWith, in
`status_error`	`string`	equals, contains, startsWith, endsWith, in
`last_read_input_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_config_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_output_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.

Datasets

Path: faraday.db.datasets.search

const rows = await corsair.faraday.db.datasets.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
`resource_type`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`string`	equals, contains, startsWith, endsWith, in
`archived_at`	`string`	equals, contains, startsWith, endsWith, in
`status_changed_at`	`string`	equals, contains, startsWith, endsWith, in
`status_error`	`string`	equals, contains, startsWith, endsWith, in
`last_read_input_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_config_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_output_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.

Graph Edges

Path: faraday.db.graphEdges.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`downstream_id`	`string`	equals, contains, startsWith, endsWith, in
`downstream_literate`	`string`	equals, contains, startsWith, endsWith, in
`downstream_status`	`string`	equals, contains, startsWith, endsWith, in
`downstream_type`	`string`	equals, contains, startsWith, endsWith, in
`upstream_id`	`string`	equals, contains, startsWith, endsWith, in
`upstream_literate`	`string`	equals, contains, startsWith, endsWith, in
`upstream_status`	`string`	equals, contains, startsWith, endsWith, in
`upstream_type`	`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.

Outcomes

Path: faraday.db.outcomes.search

const rows = await corsair.faraday.db.outcomes.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
`resource_type`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`string`	equals, contains, startsWith, endsWith, in
`archived_at`	`string`	equals, contains, startsWith, endsWith, in
`status_changed_at`	`string`	equals, contains, startsWith, endsWith, in
`status_error`	`string`	equals, contains, startsWith, endsWith, in
`last_read_input_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_config_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_output_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.

Persona Sets

Path: faraday.db.personaSets.search

const rows = await corsair.faraday.db.personaSets.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
`resource_type`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`string`	equals, contains, startsWith, endsWith, in
`archived_at`	`string`	equals, contains, startsWith, endsWith, in
`status_changed_at`	`string`	equals, contains, startsWith, endsWith, in
`status_error`	`string`	equals, contains, startsWith, endsWith, in
`last_read_input_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_config_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_output_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.

Places

Path: faraday.db.places.search

const rows = await corsair.faraday.db.places.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
`resource_type`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`string`	equals, contains, startsWith, endsWith, in
`archived_at`	`string`	equals, contains, startsWith, endsWith, in
`status_changed_at`	`string`	equals, contains, startsWith, endsWith, in
`status_error`	`string`	equals, contains, startsWith, endsWith, in
`last_read_input_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_config_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_output_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.

Scopes

Path: faraday.db.scopes.search

const rows = await corsair.faraday.db.scopes.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
`resource_type`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`string`	equals, contains, startsWith, endsWith, in
`archived_at`	`string`	equals, contains, startsWith, endsWith, in
`status_changed_at`	`string`	equals, contains, startsWith, endsWith, in
`status_error`	`string`	equals, contains, startsWith, endsWith, in
`last_read_input_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_config_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_output_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.

Streams

Path: faraday.db.streams.search

const rows = await corsair.faraday.db.streams.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
`resource_type`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`string`	equals, contains, startsWith, endsWith, in
`archived_at`	`string`	equals, contains, startsWith, endsWith, in
`status_changed_at`	`string`	equals, contains, startsWith, endsWith, in
`status_error`	`string`	equals, contains, startsWith, endsWith, in
`last_read_input_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_config_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_output_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.

Targets

Path: faraday.db.targets.search

const rows = await corsair.faraday.db.targets.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
`resource_type`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`string`	equals, contains, startsWith, endsWith, in
`archived_at`	`string`	equals, contains, startsWith, endsWith, in
`status_changed_at`	`string`	equals, contains, startsWith, endsWith, in
`status_error`	`string`	equals, contains, startsWith, endsWith, in
`last_read_input_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_config_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_output_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.

Traits

Path: faraday.db.traits.search

const rows = await corsair.faraday.db.traits.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
`resource_type`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`string`	equals, contains, startsWith, endsWith, in
`archived_at`	`string`	equals, contains, startsWith, endsWith, in
`status_changed_at`	`string`	equals, contains, startsWith, endsWith, in
`status_error`	`string`	equals, contains, startsWith, endsWith, in
`last_read_input_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_config_at`	`string`	equals, contains, startsWith, endsWith, in
`last_updated_output_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.

Webhook Endpoints

Path: faraday.db.webhookEndpoints.search

const rows = await corsair.faraday.db.webhookEndpoints.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
`url`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_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.

Overview

Plugins

Accounts

Searchable filters

Cohorts

Searchable filters

Connections

Searchable filters

Datasets

Searchable filters

Graph Edges

Searchable filters

Outcomes

Searchable filters

Persona Sets

Searchable filters

Places

Searchable filters

Scopes

Searchable filters

Streams

Searchable filters

Targets

Searchable filters

Traits

Searchable filters

Webhook Endpoints

Searchable filters

​Accounts

​Searchable filters

​Cohorts

​Searchable filters

​Connections

​Searchable filters

​Datasets

​Searchable filters

​Graph Edges

​Searchable filters

​Outcomes

​Searchable filters

​Persona Sets

​Searchable filters

​Places

​Searchable filters

​Scopes

​Searchable filters

​Streams

​Searchable filters

​Targets

​Searchable filters

​Traits

​Searchable filters

​Webhook Endpoints

​Searchable filters

Accounts

Searchable filters

Cohorts

Searchable filters

Connections

Searchable filters

Datasets

Searchable filters

Graph Edges

Searchable filters

Outcomes

Searchable filters

Persona Sets

Searchable filters

Places

Searchable filters

Scopes

Searchable filters

Streams

Searchable filters

Targets

Searchable filters

Traits

Searchable filters

Webhook Endpoints

Searchable filters