/underwriting/auto-approval-rules

GET /underwriting/auto-approval-rules

List auto-approval rules

Retrieve all auto-approval rules with optional filtering

Optional Parameters

Click here to view an exhaustive list of all available parameters

active query boolean

Filter by active status

ruleType query string

Filter by rule type

page query integer

Page number for pagination

limit query integer

Number of rules per page

Try it out

Output:

Responses

Description

Auto-approval rules retrieved successfully

{
  "rules": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "ruleType": "string",
      "criteria": {},
      "priority": 0,
      "maxAmount": "string",
      "conditions": [
        "string"
      ],
      "isActive": false,
      "createdBy": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0,
    "hasNext": false,
    "hasPrev": false
  }
}

References

#/components/schemas/AutoApprovalRule #/components/schemas/Pagination

type: object
properties:
  id:
    type: string
    description: Rule ID
  name:
    type: string
    description: Rule name
  description:
    type: string
    nullable: true
    description: Rule description
  ruleType:
    type: string
    enum:
      - auto_approve
      - auto_decline
      - flag_for_review
    description: Rule action type
  criteria:
    type: object
    description: Rule criteria configuration
  priority:
    type: integer
    description: Rule priority
  maxAmount:
    type: string
    nullable: true
    description: Maximum auto-approval amount
  conditions:
    type: array
    items:
      type: string
    description: Additional conditions
  isActive:
    type: boolean
    description: Whether rule is active
  createdBy:
    type: string
    description: ID of rule creator
  createdAt:
    type: string
    format: date-time
    description: Rule creation timestamp
  updatedAt:
    type: string
    format: date-time
    description: Last update timestamp

|
export interface AutoApprovalRule {
  /** Rule ID */
  id?: string;
  /** Rule name */
  name?: string;
  /** Rule description */
  description?: string;
  /** Rule action type */
  ruleType?: "auto_approve" | "auto_decline" | "flag_for_review";
  /** Rule criteria configuration */
  criteria?: {};
  /** Rule priority */
  priority?: number;
  /** Maximum auto-approval amount */
  maxAmount?: string;
  /** Additional conditions */
  conditions?: string[];
  /** Whether rule is active */
  isActive?: boolean;
  /** ID of rule creator */
  createdBy?: string;
  /** Rule creation timestamp */
  createdAt?: Date;
  /** Last update timestamp */
  updatedAt?: Date;
}

#/components/schemas/Pagination

OpenAPI
TypeScript

type: object
properties:
  page:
    type: integer
    description: Current page number
  limit:
    type: integer
    description: Items per page
  total:
    type: integer
    description: Total number of items
  totalPages:
    type: integer
    description: Total number of pages
  hasNext:
    type: boolean
    description: Whether there are more pages
  hasPrev:
    type: boolean
    description: Whether there are previous pages

|
export interface Pagination {
  /** Current page number */
  page?: number;
  /** Items per page */
  limit?: number;
  /** Total number of items */
  total?: number;
  /** Total number of pages */
  totalPages?: number;
  /** Whether there are more pages */
  hasNext?: boolean;
  /** Whether there are previous pages */
  hasPrev?: boolean;
}

Route Source Code

Check out the source code for this route entrypoint here: /underwriting/auto-approval-rules/route.ts

Or the swagger.yaml spec this documentation was generated from: /underwriting/auto-approval-rules/swagger.yaml