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

# Class: PersApiError

API error with backend StructuredError details

## Hierarchy

- `Error`
↳ **`PersApiError`**
↳↳ [`AuthenticationError`](/sdk-reference/classes/authenticationerror)


## Implements

- `StructuredError`


## Table of contents

### Constructors

- [constructor](/sdk-reference/classes/persapierror#constructor)


### Properties

- [code](/sdk-reference/classes/persapierror#code)
- [domain](/sdk-reference/classes/persapierror#domain)
- [category](/sdk-reference/classes/persapierror#category)
- [retryable](/sdk-reference/classes/persapierror#retryable)
- [message](/sdk-reference/classes/persapierror#message)
- [status](/sdk-reference/classes/persapierror#status)
- [title](/sdk-reference/classes/persapierror#title)
- [detail](/sdk-reference/classes/persapierror#detail)
- [details](/sdk-reference/classes/persapierror#details)
- [endpoint](/sdk-reference/classes/persapierror#endpoint)
- [method](/sdk-reference/classes/persapierror#method)


## Constructors

### constructor

• **new PersApiError**(`message`, `endpoint`, `method`, `statusCode?`, `backendError?`): [`PersApiError`](/sdk-reference/classes/persapierror)

#### Parameters

| Name | Type |
|  --- | --- |
| `message` | `string` |
| `endpoint` | `string` |
| `method` | `string` |
| `statusCode?` | `number` |
| `backendError?` | `Partial`<`StructuredError`> |


#### Returns

[`PersApiError`](/sdk-reference/classes/persapierror)

#### Overrides

Error.constructor

#### Defined in

[core/errors/index.ts:249](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/errors/index.ts#L249)

## Properties

### code

• `Readonly` **code**: `CommonErrorCode`

#### Implementation of

StructuredError.code

#### Defined in

[core/errors/index.ts:239](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/errors/index.ts#L239)

### domain

• `Readonly` **domain**: `ErrorDomain`

#### Implementation of

StructuredError.domain

#### Defined in

[core/errors/index.ts:240](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/errors/index.ts#L240)

### category

• `Readonly` **category**: `ErrorCategory`

#### Implementation of

StructuredError.category

#### Defined in

[core/errors/index.ts:241](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/errors/index.ts#L241)

### retryable

• `Readonly` **retryable**: `boolean`

#### Implementation of

StructuredError.retryable

#### Defined in

[core/errors/index.ts:242](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/errors/index.ts#L242)

### message

• `Readonly` **message**: `string`

#### Implementation of

StructuredError.message

#### Overrides

Error.message

#### Defined in

[core/errors/index.ts:243](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/errors/index.ts#L243)

### status

• `Readonly` **status**: `number`

#### Implementation of

StructuredError.status

#### Defined in

[core/errors/index.ts:244](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/errors/index.ts#L244)

### title

• `Readonly` **title**: `string`

#### Implementation of

StructuredError.title

#### Defined in

[core/errors/index.ts:245](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/errors/index.ts#L245)

### detail

• `Readonly` **detail**: `string`

#### Implementation of

StructuredError.detail

#### Defined in

[core/errors/index.ts:246](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/errors/index.ts#L246)

### details

• `Optional` `Readonly` **details**: `Record`<`string`, `unknown`>

#### Implementation of

StructuredError.details

#### Defined in

[core/errors/index.ts:247](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/errors/index.ts#L247)

### endpoint

• **endpoint**: `string`

#### Defined in

[core/errors/index.ts:251](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/errors/index.ts#L251)

### method

• **method**: `string`

#### Defined in

[core/errors/index.ts:252](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/errors/index.ts#L252)