# List error codes

> Retrieve the centralized error-code catalog.
{/* generated:versioned-pages - edit _pm-authored, not this file */}

`GET /api/error-codes`

Retrieves the collection of ErrorCode resources.

Returns the whole error-code catalog, each `message` localized by the `Flowkiwi-Locale` header. Narrow the result with the optional `domain`, `httpStatus` and `slug` query filters.

## Query parameters

| Name           | Type       | Required | Description                                                                                                                                                                                                                                                                          |
| -------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `properties[]` | `string[]` | -        | Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty} |
| `domain`       | `string`   | -        | Filter by error domain (e.g. "validation", "product").                                                                                                                                                                                                                               |
| `httpStatus`   | `integer`  | -        | Filter by HTTP status code (e.g. 404, 422).                                                                                                                                                                                                                                          |
| `slug`         | `string`   | -        | Filter by exact error slug (e.g. "product.not_found").                                                                                                                                                                                                                               |

## Response

**200** - ErrorCode collection

| Property     | Type          | Required | Description |
| ------------ | ------------- | -------- | ----------- |
| `search`     | `object`      | -        |             |
| `totalItems` | `integer`     | -        |             |
| `member`     | `ErrorCode[]` | Yes      |             |

## Errors

**403** - Forbidden

| Property      | Type               | Required | Description                                                                                                                          |
| ------------- | ------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `@context`    | `string \| object` | -        |                                                                                                                                      |
| `@id`         | `string`           | Yes      |                                                                                                                                      |
| `@type`       | `string`           | Yes      |                                                                                                                                      |
| `code`        | `string`           | -        | Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.                |
| `description` | `string \| null`   | -        |                                                                                                                                      |
| `detail`      | `string \| null`   | -        | A human-readable explanation specific to this occurrence of the problem.                                                             |
| `instance`    | `string \| null`   | -        | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
| `message`     | `string`           | -        | End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.      |
| `slug`        | `string`           | -        | Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.                                    |
| `status`      | `integer \| null`  | -        |                                                                                                                                      |
| `title`       | `string \| null`   | -        | A short, human-readable summary of the problem. For a catalogued error it repeats the `slug`.                                        |
| `type`        | `string`           | -        | A URI reference that identifies the problem type. For a catalogued error it is the error code resource, `/api/error-codes/{code}`.   |

## Examples

### Example request

```bash
curl -X GET 'https://<tenant>.product-management.flowkiwi.net/api/error-codes' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Flowkiwi-Api-Version: unstable' \
  -H 'Accept: application/ld+json'
```

### Example response

```json
{
  "search": {
    "@type": "string",
    "mapping": [
      {
        "@type": "string",
        "property": "string",
        "required": true,
        "variable": "string"
      }
    ],
    "template": "string",
    "variableRepresentation": "string"
  },
  "totalItems": 0,
  "member": [
    {
      "@context": "string",
      "@id": "string",
      "@type": "ErrorCode",
      "code": "string",
      "description": "string",
      "domain": "string",
      "httpStatus": 0,
      "message": "string",
      "slug": "string"
    }
  ]
}
```