Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt

Use this file to discover all available pages before exploring further.

The Zendesk plugin syncs data locally. Use corsair.zendesk.db.<entity>.search({ data, limit?, offset? }) with the filters listed per entity.
New to Corsair? See database operations, data synchronization, and multi-tenancy.

​
Comments

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

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idnumberequals, gt, gte, lt, lte, in
ticketIdnumberequals, gt, gte, lt, lte, in
bodystringequals, contains, startsWith, endsWith, in
authorIdnumberequals, gt, gte, lt, lte, in
publicbooleanequals
createdAtdateequals, 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.

​
Tickets

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

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idnumberequals, gt, gte, lt, lte, in
subjectstringequals, contains, startsWith, endsWith, in
descriptionstringequals, contains, startsWith, endsWith, in
statusstringequals, contains, startsWith, endsWith, in
prioritystringequals, contains, startsWith, endsWith, in
requesterIdnumberequals, gt, gte, lt, lte, in
assigneeIdnumberequals, gt, gte, lt, lte, in
organizationIdnumberequals, gt, gte, lt, lte, in
groupIdnumberequals, gt, gte, lt, lte, in
createdAtdateequals, before, after, between
updatedAtdateequals, 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.

​
Users

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

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idnumberequals, gt, gte, lt, lte, in
namestringequals, contains, startsWith, endsWith, in
emailstringequals, contains, startsWith, endsWith, in
rolestringequals, contains, startsWith, endsWith, in
activebooleanequals
timeZonestringequals, contains, startsWith, endsWith, in
localestringequals, contains, startsWith, endsWith, in
createdAtdateequals, before, after, between
updatedAtdateequals, 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.