Filtering

Filter and search resources using the SDK's powerful query options.

Basic Filtering

Pass filter options to any list method:

const highRisks = await client.risks.list({
  filter: {
    severity: 'high',
  }
});

Filter Operators

Equality

// Exact match
const activeControls = await client.controls.list({
  filter: { status: 'active' }
});

// Multiple values (OR)
const criticalOrHigh = await client.risks.list({
  filter: { severity: { in: ['critical', 'high'] } }
});

Comparison

// Greater than
const recentRisks = await client.risks.list({
  filter: { createdAt: { gt: '2024-01-01' } }
});

// Less than or equal
const oldTasks = await client.tasks.list({
  filter: { dueDate: { lte: '2024-06-30' } }
});

// Range
const dateRange = await client.risks.list({
  filter: {
    createdAt: { gte: '2024-01-01', lt: '2024-07-01' }
  }
});

Text Search

// Contains (case-insensitive)
const searchResults = await client.policies.search('security');

// Like pattern
const matched = await client.risks.list({
  filter: { name: { like: '%access%' } }
});

Negation

// Not equal
const notClosed = await client.tasks.list({
  filter: { status: { ne: 'closed' } }
});

// Not in list
const notLowRisks = await client.risks.list({
  filter: { severity: { nin: ['low', 'informational'] } }
});

Filter Operators Reference

Operator	Description	Example
eq	Equals (default)	{ status: 'active' }
ne	Not equals	{ status: { ne: 'closed' } }
gt	Greater than	{ score: { gt: 50 } }
gte	Greater than or equal	{ score: { gte: 50 } }
lt	Less than	{ score: { lt: 100 } }
lte	Less than or equal	{ score: { lte: 100 } }
in	In array	{ status: { in: ['a', 'b'] } }
nin	Not in array	{ status: { nin: ['x', 'y'] } }
like	Pattern match	{ name: { like: '%test%' } }

Sorting

Sort results by any field:

// Ascending (default)
const oldestFirst = await client.risks.list({
  sort: 'createdAt'
});

// Descending (prefix with -)
const newestFirst = await client.risks.list({
  sort: '-createdAt'
});

// Multiple fields
const sorted = await client.risks.list({
  sort: '-severity,createdAt'
});

Combining Filters

Multiple Conditions (AND)

// All conditions must match
const filtered = await client.risks.list({
  filter: {
    severity: 'high',
    status: 'open',
    owner: 'user@example.com',
  }
});

Complex Queries

// High severity risks created in 2024, sorted by date
const complexQuery = await client.risks.list({
  filter: {
    severity: { in: ['critical', 'high'] },
    createdAt: { gte: '2024-01-01' },
    status: { ne: 'closed' },
  },
  sort: '-createdAt',
  page: { size: 50 },
});

Including Related Resources

Fetch related resources in a single request:

// Include linked controls with each risk
const risksWithControls = await client.risks.list({
  include: ['controls'],
});

// Multiple includes
const fullData = await client.risks.list({
  include: ['controls', 'tasks', 'owner'],
});

Field Selection

Select only the fields you need:

// Only fetch specific fields
const minimal = await client.risks.list({
  fields: {
    risks: ['id', 'name', 'severity'],
  }
});

Examples

Dashboard Query

// Fetch data for a risk dashboard
const dashboardData = await client.risks.list({
  filter: {
    status: { ne: 'closed' },
  },
  sort: '-severity,-createdAt',
  page: { size: 100 },
  include: ['controls'],
});

Overdue Tasks

const today = new Date().toISOString().split('T')[0];

const overdueTasks = await client.tasks.list({
  filter: {
    dueDate: { lt: today },
    status: { ne: 'completed' },
  },
  sort: 'dueDate',
});

console.log(`Found ${overdueTasks.data.length} overdue tasks`);

Search with Filters

// Search policies containing "security" that are published
const policies = await client.policies.search('security', {
  filter: { status: 'published' },
  sort: '-updatedAt',
});

Type-Safe Filters

The SDK provides type checking for filter fields:

// ✅ Valid filter
const valid = await client.risks.list({
  filter: { severity: 'high' }
});

// ❌ TypeScript error - invalid field
const invalid = await client.risks.list({
  filter: { invalidField: 'value' }
});

Next Steps

• Resources - Explore specific resources
• API Reference - Complete API documentation