Database

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

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

Brands

Path: brandfetch.db.brands.search

const rows = await corsair.brandfetch.db.brands.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
`domain`	`string`	equals, contains, startsWith, endsWith, in
`claimed`	`boolean`	equals
`description`	`string`	equals, contains, startsWith, endsWith, in
`longDescription`	`string`	equals, contains, startsWith, endsWith, in
`qualityScore`	`number`	equals, gt, gte, lt, lte, in
`isNsfw`	`boolean`	equals
`urn`	`string`	equals, contains, startsWith, endsWith, in
`checkedAt`	`date`	equals, before, after, between

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.

Companies

Path: brandfetch.db.companies.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`brandId`	`string`	equals, contains, startsWith, endsWith, in
`employees`	`number`	equals, gt, gte, lt, lte, in
`foundedYear`	`number`	equals, gt, gte, lt, lte, in
`kind`	`string`	equals, contains, startsWith, endsWith, in
`city`	`string`	equals, contains, startsWith, endsWith, in
`country`	`string`	equals, contains, startsWith, endsWith, in
`countryCode`	`string`	equals, contains, startsWith, endsWith, in
`region`	`string`	equals, contains, startsWith, endsWith, in
`state`	`string`	equals, contains, startsWith, endsWith, in
`subregion`	`string`	equals, contains, startsWith, endsWith, in
`checkedAt`	`date`	equals, before, after, between

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: brandfetch.db.webhooks.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`urn`	`string`	equals, contains, startsWith, endsWith, in
`url`	`string`	equals, contains, startsWith, endsWith, in
`description`	`string`	equals, contains, startsWith, endsWith, in
`enabled`	`boolean`	equals
`checkedAt`	`date`	equals, before, after, between

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

Brands

Searchable filters

Companies

Searchable filters

Webhooks

Searchable filters

​Brands

​Searchable filters

​Companies

​Searchable filters

​Webhooks

​Searchable filters

Brands

Searchable filters

Companies

Searchable filters

Webhooks

Searchable filters