[PERS SDK - v2.3.26](/sdk-reference/readme) / [Exports](/sdk-reference/modules) / ApiResponse

# Interface: ApiResponse<T>

Generic API response wrapper for client-side operations
Provides consistent structure for success/error handling

Aligns with StructuredError pattern from @explorins/pers-shared
Note: PERS API endpoints return DTOs directly (not wrapped in success/data)
This is for client-side consistency when apps need response wrappers

## Type parameters

| Name |
|  --- |
| `T` |


## Table of contents

### Properties

- [success](/sdk-reference/interfaces/apiresponse#success)
- [data](/sdk-reference/interfaces/apiresponse#data)
- [message](/sdk-reference/interfaces/apiresponse#message)
- [error](/sdk-reference/interfaces/apiresponse#error)


## Properties

### success

• **success**: `boolean`

Indicates if the operation was successful

#### Defined in

[shared/interfaces/pers-shared-lib.interfaces.ts:32](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/shared/interfaces/pers-shared-lib.interfaces.ts#L32)

### data

• **data**: `T`

Response data (present on success)

#### Defined in

[shared/interfaces/pers-shared-lib.interfaces.ts:34](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/shared/interfaces/pers-shared-lib.interfaces.ts#L34)

### message

• `Optional` **message**: `string`

Optional success message

#### Defined in

[shared/interfaces/pers-shared-lib.interfaces.ts:36](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/shared/interfaces/pers-shared-lib.interfaces.ts#L36)

### error

• `Optional` **error**: `Object`

Structured error details (present on failure)

#### Type declaration

| Name | Type | Description |
|  --- | --- | --- |
| `code` | `string` | Error code (e.g., 'INVALID_REQUEST', 'NOT_FOUND') |
| `message` | `string` | User-friendly error message |
| `details?` | `unknown` | Additional error context |


#### Defined in

[shared/interfaces/pers-shared-lib.interfaces.ts:38](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/shared/interfaces/pers-shared-lib.interfaces.ts#L38)