Catalog Attributes — Datagrid Listing

Paginated, filterable, and sortable attribute list that mirrors the Bagisto admin Catalog → Attributes datagrid 1:1. This is the authoritative attribute-management listing for the admin API — same columns, same filters, and the same sort options used by the datagrid.

For attribute types, options, and the configurable and filterable flags, see the Attributes overview.

Endpoint

Endpoint	Method	Authentication
/api/admin/catalog/attributes	GET	Admin Bearer token

Query Parameters

Parameter	Type	Description	Example
page	integer	Page number (1-based, default 1)	1
per_page	integer	Items per page (default 10, max 50)	10
id	string	Filter by attribute ID — single integer or comma-separated list (e.g. "1" or "1,2")	1
code	string	Partial attribute code match (SQL LIKE %value%)	color
type	string	Exact attribute type filter	select
admin_name	string	Partial admin name match (SQL LIKE %value%)	Color
is_required	integer	Filter by is_required: 0 = no, 1 = yes	1
is_unique	integer	Filter by is_unique: 0 = no, 1 = yes	0
is_filterable	integer	Filter by is_filterable: 0 = no, 1 = yes	1
is_configurable	integer	Filter by is_configurable: 0 = no, 1 = yes	0
is_visible_on_front	integer	Filter by is_visible_on_front: 0 = no, 1 = yes	1
is_user_defined	integer	Filter by is_user_defined: 0 = no, 1 = yes	1
value_per_locale	integer	Filter by value_per_locale: 0 = no, 1 = yes	0
value_per_channel	integer	Filter by value_per_channel: 0 = no, 1 = yes	0
locale	string	Locale code for translation resolution (default: app locale)	en
sort	string	Column to sort by (see Sorting section below)	id
order	string	Sort direction: asc or desc (default desc)	desc

Valid type values: text, textarea, price, boolean, select, multiselect, datetime, date, image, file, checkbox

Response Shape

Responses use the standard admin { data, meta } envelope.

meta object

Field	Type	Description
currentPage	integer	Current page number (1-based)
perPage	integer	Number of items on this page
lastPage	integer	Total number of pages
total	integer	Total matching attributes
from	integer	1-based index of the first item on this page
to	integer	1-based index of the last item on this page

Row fields (data[])

Field	Type	Description
id	integer	Attribute ID
code	string	Attribute code (e.g. color, size)
type	string	Attribute type (e.g. select, text, boolean)
adminName	string	Internal admin-facing label
isRequired	integer	1 = required on product forms, 0 = optional
isUnique	integer	1 = value must be unique across products
valuePerLocale	integer	1 = separate value per store locale
valuePerChannel	integer	1 = separate value per channel
isFilterable	integer	1 = attribute appears in layered navigation filters
isConfigurable	integer	1 = used as a configurable variant axis
isVisibleOnFront	integer	1 = shown on the product page storefront
isUserDefined	integer	1 = created by an admin user (not a system attribute)
swatchType	string|null	Swatch rendering mode (color, image, text); null for non-swatch types
position	integer	Display order position
locale	string|null	Locale code used for name resolution
createdAt	string|null	ISO 8601 creation timestamp
updatedAt	string|null	ISO 8601 last-update timestamp
translations	null	Always null in list responses — full translations are available via the detail endpoint GET /api/admin/catalog/attributes/{id}
options	null	Always null in list responses — option data is available via the detail endpoint
validation	null	Always null in list responses — available via the detail endpoint
defaultValue	null	Always null in list responses — available via the detail endpoint

Sorting

Parameter form	Example
Separate sort + order params	?sort=id&order=desc

Sortable columns:

sort value	Sorts by
id	Attribute ID (default)
code	Attribute code
admin_name	Admin label
type	Attribute type
position	Display order position

Pagination

• Default page size: 10 items
• Maximum page size: 50 items
• Use ?page=N for page navigation and ?per_page=N to control page size

Errors

HTTP Status	Cause
401 Unauthorized	Missing, expired, or revoked admin Bearer token
401 Unauthorized	Missing or invalid admin Bearer token

Unknown filter parameters are silently ignored — no error is returned.

Fields That Stay Null on the Listing

translations, options, validation, defaultValue, isComparable, enableWysiwyg, and regex are present on every row but always null. All resolve only on GET /api/admin/catalog/attributes/{id}, which loads every locale translation and, for option types, all options with their own translations.

Behaviour Worth Knowing

• The boolean flags are integers, 0 or 1, not booleans.
• System attributes are included. The listing returns both Bagisto's built-in attributes and admin-created ones. Pass ?is_user_defined=1 for admin-created only, or ?is_user_defined=0 for system only — worth knowing because system attributes cannot be deleted.
• adminName is not locale-aware. It is the internal label set when the attribute was created. ?locale selects which translation row resolves the display name, falling back to adminName when the requested locale has no row.
• swatchType stays null on a non-swatch attribute rather than carrying a default.
• per_page caps at 50; a value of 0 or less falls back to 10.