# The resource error object

A resource error object is returned as part of the response body of each successful list or retrieve API call to the `/api/resource_errors` endpoint.

## Fields

| Field                            | Type       | Description                                                                                                                                                                                         |
| -------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                         | `string`   | `resource_errors`                                                                                                                                                                                   |
| **id**                           | `string`   | The resource error unique identifier                                                                                                                                                                |
| links.**self**                   | `string`   | The resource error endpoint URL                                                                                                                                                                     |
| attributes.**name**              | `string`   | The resource attribute name related to the error.                                                                                                                                                   |
| attributes.**code**              | `string`   | The error code.                                                                                                                                                                                     |
| attributes.**message**           | `string`   | The error message.                                                                                                                                                                                  |
| attributes.**created\_at**       | `datetime` | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**       | `datetime` | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**reference**         | `string`   | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
| attributes.**reference\_origin** | `string`   | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**metadata**          | `object`   | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.                                        |
| relationships.**resource**       | `object`   | The resource the error belongs to.                                                                                                                                                                  |
| relationships.**event\_stores**  | `array`    | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                    | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |