Skip to content

DoCurious API Reference / types / ApiResponse

Interface: ApiResponse<T>

Defined in: types/common.types.ts:17

Standard wrapper for all single-entity API responses.

Example

ts
const response: ApiResponse<User> = {
  success: true,
  data: user,
  message: 'User fetched successfully',
}

Type Parameters

T

T

The type of the response payload

Properties

data

data: T

Defined in: types/common.types.ts:19


error?

optional error: string

Defined in: types/common.types.ts:21

Error message present when success is false


message?

optional message: string

Defined in: types/common.types.ts:23

Optional human-readable message for toast notifications


success

success: boolean

Defined in: types/common.types.ts:18

DoCurious Platform Documentation