Appearance

API Types ​

File Information ​

  • Path: app/types/api.ts and app/types/api.d.ts
  • Purpose: API request/response interfaces and global declarations

Overview ​

API types define request and response interfaces. Located in app/types/api.ts.

ApiResponse ​

Generic API response wrapper.

typescript
interface ApiResponse<T> {
  data: T
  message?: string
  success: boolean
}

ApiError ​

API error structure.

typescript
interface ApiError {
  error: string
  message?: string
  code?: number
}

LoginRequest ​

Login request payload.

typescript
interface LoginRequest {
  email: string
  password: string
  workspace_id?: number
}

LoginResponse ​

Login response.

typescript
interface LoginResponse {
  token: string
  user: User
}

SearchRequest ​

Search request payload.

typescript
interface SearchRequest {
  q: string
  query_by?: string
  filter_by?: string
  sort_by?: string
  per_page?: number
  page?: number
}

SearchResponse ​

Search response.

typescript
interface SearchResponse {
  hits: SearchResult[]
  found: number
  page: number
  request_params: object
}

File Path: app/types/api.ts