List error codes

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	-
Show search fields Property Type Required Description @type string - mapping object[] - Show mapping fields Property Type Required Description @type string - property string | null - required boolean - variable string - template string - variableRepresentation string -
totalItems	integer	-
member	ErrorCode[]	required
Show member fields Property Type Required Description @context string | object - @id string required @type string required code string - Immutable UUID of the error. description string - Technical English message (developer-facing, stable). domain string - httpStatus integer - message string - User-friendly message in the request locale. slug string -

Errors

403 - Forbidden

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
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}.