Reports

List report definitions and execute reports.

REST /api/v1API key authentication4 endpoints

GET/api/v1/reports

List available report definitions

Query schema

const listQuerySchema = z.object({
  category: z.string().optional(),
  source: z.enum(['system', 'user']).optional(),
  limit: z.coerce.number().int().min(1).max(100).default(50),
  offset: z.coerce.number().int().min(0).default(0),
});

Response200Returns results in data and page totals, limit and offset in pagination.

GET/api/v1/reports/:id

Get a single report definition

Path parametersid: string

Response200Returns the result in the data field.

POST/api/v1/reports/:id/execute

Execute a report and get results

Path parametersid: string

JSON body schema

const executeBodySchema = z.object({
  filterValues: z.record(z.unknown()).optional(),
  page: z.coerce.number().int().min(1).default(1),
  pageSize: z.coerce.number().int().min(1).max(500).default(100),
  scope: z
    .object({ kind: z.enum(['project', 'person', 'contact']), id: z.string().uuid() })
    .strict()
    .optional(),
});

Response200Returns the result in the data field.

GET/api/v1/reports/categories

List available report categories

Response200Returns the result in the data field.